Campaign Subscription

ENDPOINT: POST /v1/patients/{patientId}/subscribe-campaign

Campaign Subscription

This API call is used by our partners to provide a set series of updates to the patient, via an initial call and then subsequent scheduled events within pre-determined parameters.

A campaign subscription will:

  1. Update the patient’s status in our database and subscribe him/her to the series;
  2. Create an initial patient interaction, notification, or call to action;
  3. Schedule a subsequent patient interaction(s), notification(s), or call(s) to action

Specific campaign names and values can be mapped to various content and business rules that the Partner would like to enable for patients and caregivers. Events are mapped to the user experience as built by the partner with HelpAround by using one of its Gateway tools.

Here is an example of subscribing a patient to a campaign:

				
					{
  "name": "campaign_name",
  "additionalData": [
    {
      "key": "key 1",
      "value": "value 1"
    },
    {
      "key": "key 2",
      "value": "value 2"
    },
    {
      "key": "key 3",
      "value": "value 3"
    }
  ],
  "phoneNumber": "{{test-user-phone-number}}",
  "externalId": "{{test-user-external-user-id}}",
  "supportProgramId": "{{partners-support-program-id}}"
}

Standard Response Codes

StatusCodeMessageDescription
200N/APatient updated successfullyPatient updated successfully
4010UnauthorizedPlease verify with RxWare that you are authorized to use the RxWare API.
4001006Patient Not FoundPatient cannot be found in the system.
4002002Invalid Support Program IDThis means that the supportProgramId you provided is invalid.
Please check your Support Program ID.
4001005User Previously Unsubscribed
403403Invalid TokenThis means that the bearer token you supplied is not valid for this Support Program.
Please verify your credentials.

NEXT: ➡️ User Updates API

Campaign Subscription
Skip to content