User Updates API

Home » RxWare Developer Site » User Updates API

ENDPOINT: POST /v1/patients/{patientId}/update_details

Endpoint Example For the User Updates API endpoint, you will need to replace the {patientId} variable with your patient's HA ID.
Example: POST /v1/patients/ha98402932/subscribe-campaign

Our partners use the User Updates API calls to update an existing patient’s personal details or preferences.

Calling this endpoint will update the patient’s status in our database.

These action events can be used for different types of consent, such as SMS.

The additionalData array details whether the user opted in, opted out, or revoked past consent.

Below is an example of how to opt-out a patient:

				
					{
  "action": {
    "name": "consent",
    "value": "sms",
    "additionalData": [
      {
        "key": "opt-in",
        "value": "false"
      }
    ]
  },
  "phoneNumber": "{{test-user-phone-number}}",
  "externalId": "{{test-user-external-user-id}}",
  "supportProgramId": "{{partners-support-program-id}}"
}

Standard HTTP Response Codes

Status	Code	Message	Description
`200`	N/A	Successful	User opted out
`208`	N/A	User already opted out	User already opted out
`400`	N/A	Program ID `{{partners-support-program-id}}` not found	Please check the support program ID and resubmit
`422`	N/A	Patient Not Found	Patient cannot be found in the RxWare system.

NEXT: ➡️ Media API