POST Api/Participant/Put

This method allows a provider to update an existing participant record using the AlertID (unique id of the participant as assigned by TouchPointCare). All fields other than AlertID are optional. Only provide the fields you would like to update.

Request Information

URI Parameters

None.

Body Parameters

Participant Data.

Participant
NameDescriptionTypeAdditional information
AlertID

Gets or sets the participant alert ID (unique ID of the participant as assigned by TouchPointCare).

integer

None.

ProviderUniqueID

Gets or sets the participant's provider unique ID (unique ID of the participant as assigned by the provider).

string

None.

FirstName

Gets or sets the first name of the participant.

string

None.

LastName

Gets or sets the last name of the participants.

string

None.

MobileHelpDeviceID

Gets or sets the mobile help device ID (legacy).

string

None.

AccountName

Gets or sets the account name associated with the participant.

string

None.

Devices

Gets or sets a list of devices assigned to the participant.

Collection of Device

None.

IsActive

Gets or sets a value indicating whether the the participant is active or not.

boolean

None.

IsSuspended

Gets or sets a value indicating whether the the participant is suspended or not.

boolean

None.

AddedReferredDate

Gets or sets the added or referred date.

date

None.

FirstActivityDate

Gets or sets the first activity date (date of first vital or response to a telehealth question).

date

None.

LastActivityDate

Gets or sets the last activity date (date of most recent vital or response to a telehealth question).

date

None.

TriageProScore

Gets or sets the TriagePro score.

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "AlertID": 1,
  "ProviderUniqueID": "sample string 2",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "MobileHelpDeviceID": "sample string 5",
  "AccountName": "sample string 6",
  "Devices": [
    {
      "DeviceType": "sample string 1",
      "DeviceId": "sample string 2"
    },
    {
      "DeviceType": "sample string 1",
      "DeviceId": "sample string 2"
    }
  ],
  "IsActive": true,
  "IsSuspended": true,
  "AddedReferredDate": "2025-06-14T22:20:51.3723562-05:00",
  "FirstActivityDate": "2025-06-14T22:20:51.3723562-05:00",
  "LastActivityDate": "2025-06-14T22:20:51.3723562-05:00",
  "TriageProScore": 1.0
}

application/xml, text/xml

Sample:
<Participant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPC.Core">
  <AccountName>sample string 6</AccountName>
  <AddedReferredDate>2025-06-14T22:20:51.3723562-05:00</AddedReferredDate>
  <AlertID>1</AlertID>
  <Devices xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPC.Core.BusinessEntities">
    <d2p1:Device>
      <d2p1:DeviceId>sample string 2</d2p1:DeviceId>
      <d2p1:DeviceType>sample string 1</d2p1:DeviceType>
    </d2p1:Device>
    <d2p1:Device>
      <d2p1:DeviceId>sample string 2</d2p1:DeviceId>
      <d2p1:DeviceType>sample string 1</d2p1:DeviceType>
    </d2p1:Device>
  </Devices>
  <FirstActivityDate>2025-06-14T22:20:51.3723562-05:00</FirstActivityDate>
  <FirstName>sample string 3</FirstName>
  <IsActive>true</IsActive>
  <IsSuspended>true</IsSuspended>
  <LastActivityDate>2025-06-14T22:20:51.3723562-05:00</LastActivityDate>
  <LastName>sample string 4</LastName>
  <MobileHelpDeviceID>sample string 5</MobileHelpDeviceID>
  <ProviderUniqueID>sample string 2</ProviderUniqueID>
  <TriageProScore>1</TriageProScore>
</Participant>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Participant'.

Response Information

Resource Description

A TPCResponse object.

TPCResponse
NameDescriptionTypeAdditional information
result

string

None.

error_code

integer

None.

message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "result": "sample string 1",
  "error_code": 1,
  "message": "sample string 2"
}

application/xml, text/xml

Sample:
<TPCResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPC.API.Models">
  <error_code>1</error_code>
  <message>sample string 2</message>
  <result>sample string 1</result>
</TPCResponse>