Menu
Re-Invite API
ENDPOINT: POST /v1/patients/reinvite
The Re-Invite API call will trigger the invite SMS to the patient again.
Partners can use this API to resend the program initiation message to a patient/caregiver when the onboarding/enrollment process is not completed.
By triggering a Re-Invite, RxWare will resend the same initiation message as in the initial invite call.
Limitations for this API call:
A patient/caregiver can receive a re-invite only if s/he has not received an Invitation during the preceding 24 hours and has not completed onboarding/enrollment.
In the example below, you would replace the following data elements:
{{test-user-external-user-id}}= Replace with the value you used on the initial Create Patient call to tie the request back to the correct patient{{test-user-phone-number}}= The value you provided on the initial Create Patient call{{partners-support-program-id}}= The value you provided on the initial Create Patient call
{
"externalId": "{{test-user-external-user-id}}",
"phoneNumber": "{{test-user-phone-number}}",
"supportProgramId": "{{partners-support-program-id}}",
"additionalData": []
}
Standard HTTP Response Codes
| Status | Code | Message | Description |
|---|---|---|---|
200 | N/A | Patient updated successfully | Patient updated successfully |
400 | 3016 | the external id not relevant to the provided phone number | Patient's External ID Does Not Match Their Phone Number |
400 | 3017 | the patient with provided external id not found | Patient's External ID is Invalid |
400 | 3014 | provided phone number not related to patient | Phone Number Not Related to a Patient |
400 | 3018 | the patient already finished enrollment | Patient Has Already Finished Enrollment |