Contents x
    Onboard A Customer/Patient
    • 19 Nov 2024
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Onboard A Customer/Patient

    • Updated on 19 Nov 2024
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    The API endpoint /cdm/client//onboard facilitates the onboarding of customers or patients while sending them a welcoming SMS. It requires an API key and client ID as header and path parameters, respectively. The body must include a JSON document detailing customer information, such as a unique identifier (ccid), names, date of birth, and address. Additional parameters include a product group ID, consent type, and notification channels, specifically for SMS. The API allows for the deactivation of previous connections and supports various input properties for customization. Responses include success messages and error codes for various issues, such as unauthorized access or conflicts. This API is designed to streamline customer onboarding and enhance communication through SMS notifications.

    Post
    /cdm/client/{client_id}/onboard

    This API can be used to both Onboard a Customer or Patient AND send them an SMS text message with a welcoming experience.

    Header parameters
    xx-relay-api-key
    stringRequired

    Contains the API key needed.

    Path parameters
    client_id
    stringRequired

    Client ID

    Minimum1
    Body parameters

    A customer onboard JSON document

    Expand All
    object
    trigger_id
    string

    If specified, the onboarded Customer or Patient will be sent the experience associated with the specifiedi trigger_id.

    Max length100
    Example7028cb2e-d62d-4d5f-a285-91d25781ea86
    launched_by
    object (launched_by)

    This object contains two properties, lb_name and lb_source, which a Client can use to identify their source system that made this REST API call.

    lb_name
    string

    Can be used by clients to determine the specific user if the source system in lb_source is CX portal or if it was system initiated.

    Max length255
    Example[email protected]
    lb_source
    string

    Can be used by clients to determine whether the source system launching the journey was CX Portal or their own via API call.

    Max length255
    Examplecompany-system
    product_group_id
    string Required

    Required field that specifies the product group Id that will be assigned to the Customer or Patient. A Customer or Patient can only be assigned to a single product group.

    Max length100
    Exampledefault
    deactivate_previous_connections
    boolean

    Specifies if previous connections (mobile numbers) should be removed.

    Valid values[ "true - If an existing Customer or Patient, then deactivate all previous mobile numbers associated with the specified ccid.", "false - If an existing Customer or Patient, then add the new mobile number to the list of number associated with the specified ccid." ]
    ExampleTrue
    input_parameters
    object (inputParameters)

    This property contains a collection of input properties for the Journey. Input parameters are defined when the Journey is created or updated. Each input property must be prefixed with input_.

    input_account_active
    string
    Max length100
    ExampleTrue
    input_account_funding_date
    string
    Max length100
    Example12/01/2023
    asset_id
    string

    This asset id to override in the message.

    Max length100
    Example5da610e9e-896r-3ba4-7a13-321c87c7ff6a
    client_message_tag
    string

    This is a arbitrary passthrough property specified by the Client for reporting and tracking by the Client.

    Max length100
    ExamplecampaignA
    customer
    object (customer) Required
    ccid
    string Required

    Uniquely identifies a Customer or Patient.

    Max length100
    ExampleBAK-11984-007
    secondary_account_id
    string

    A second identifier representing the Customer or Patient.

    Max length100
    ExampleABC123
    first_name
    string

    Contains the first name of the Customer or Patient.

    Max length100
    ExampleRoger
    middle_name
    string

    Contains the middle name of the Customer or Patient.

    Max length100
    ExampleHarold
    last_name
    string

    Contains the last name of the Customer or Patient.

    Max length100
    ExampleMoore
    date_of_birth
    string

    Contains the date of birth of the Customer or Patient. Format (yyyy-mm-dd).

    Example1954-12-01
    ssn_last4
    string

    Contains the last 4 digits of the Customer or Patient.

    Max length4
    Example1234
    gender
    string

    Identifies the gender of the Customer or Patient.

    Max length1
    ExampleM
    addresses
    Array of object
    object
    address1
    string

    Identifies the first line of the address.

    Max length100
    Example201 King of Prussia Road
    address2
    string

    Identifies the second line of the address.

    Max length100
    ExampleSuite 161
    city
    string

    Identifies the city of the address.

    Max length100
    ExampleRadnor
    state_province
    string

    Identifies the state or province of the address.

    Max length2
    ExamplePA
    postal_code
    string

    Identifies postal code of the address.

    Max length10
    Example19087
    country
    string

    Identifies country of the address.

    Max length2
    ExampleUSA
    notification_channels
    Array of object
    object
    channel_type
    string

    Identifies the channel type of the channel_addr field.

    Valid values[ "sms" ]
    Examplesms
    channel_addr
    string

    Contains the channel address.

    Minimum10
    Max length11
    Example6105551212
    consent_type
    string

    Identifies the consent of the Customer or Patient.

    Valid values[ "written", "express", "stop" ]
    Examplewritten
    phone_type
    string
    Max length10
    Examplemobile
    ext
    object
    member_since
    string
    Example1999
    membership_level
    string
    Examplegold
    renewal_date
    string
    Example05/01/2024
    Responses
    200

    OK

    Expand All
    object

    Example message success details.

    message
    string
    Max length100
    ExampleAccepted
    mobile_analysis_results
    object
    15555555555
    string
    Exampletype-not-resolved
    15556667777
    string
    Examplelandline
    400

    Invalid request

    401

    Unauthorized

    404

    Not Found - The requested resource was not found. Please verify the route parameter.

    409

    Conflict - Indicates the request could not be processed. A common reason is when attempting to create a new Journey object, but the ID already exists in the system.

    500

    An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request.

    Was this article helpful?
    What's Next