Onboarding API: This APIs is used to onboard a Customer or Patient to the Relay platform. If the Customer or Patient does not exist, they will be onboarded (added) to the platform. If the Customer or Patient already exists, they will be updated with the new information being provided. The onboarding API can optionally send an experience to the newly onboarded (or updated) Customer or Patient during the same call. This is accomplished by setting the optional trigger_id parameter in the request body. 

  • A single CCID is permitted to have up to 50 phone numbers associated with it. And a single phone number can be associated with up to 50 CCIDs. 
  • Enabling Mobile Analysis and strict onboarding configuration will add an extra mobile_analysis_results section to the 200 response body if the result of mobile analysis returns a phone type that is not mobile. 

Messaging API: Once the Customer or Patient is onboarded, the Messaging APIs can be used to either trigger an experience being sent to a specific Customer or Patient, but also supports bulk triggering of experiences to multiple Customers or Patients.