Using the additionalData Field

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

Case Update messages may contain any variable data you choose, which RxWare will insert in the appropriate place within the SMS message without processing or reading the data.

When this variable data is included, additionalData with a key-value pair must be included in the call for the name field.

additionalData Examples

Here we are able to add a variable date field in the body of the notify.sms.next.call SMS message to notify the patient of an upcoming outreach attempt:

				
					{
    "status": {
        "name": "notify.sms.next.call",
        "text": "",
        "additionalData":[
          {
             "key:"date", 
             "value":"06/22/2024"
          }
        ]
    },
    "phoneNumber": "{{test-user-phone-number}}",
    "externalId": "{{test-user-external-user-id}}",
    "supportProgramId": "{{partners-support-program-id}}"
}

Example code to notate a patient’s Copay Savings Card details using the additionalData field on the financial.support.status event:

				
					{
  "status": {
    "name": "financial.support.status",
    "text": "approved",
    "additionalData": [
      {
        "key": "coPayMember",
        "value": "098765999546824"
      },
      {
        "key": "coPayBinNumber",
        "value": "610279"
      },
      {
        "key": "pharmacyphone",
        "value": "(704) 555-5555"
      }
    ]
  },
  "phoneNumber": "{{test-user-phone-number}}",
  "externalId": "{{test-user-external-user-id}}",
  "supportProgramId": "{{partners-support-program-id}}"
}

NEXT: ➡️ Tracking Shipment Updates

Using the additionalData Field
Skip to content