Contents x
    Onboarding File
    • 15 Apr 2025
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Onboarding File

    • Updated on 15 Apr 2025
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    The Onboarding File format is used to onboard Customers or Patients to Relay. During the onboarding process, an optional message can be sent to the Customer or Patient. The message to be sent is identified by the trigger_id field.

    If a Customer or Patient is re-onboarded, then the existing Customer or Patient data will be updated with the new data provided in the onboarding file.

    If a trigger_id is specified and the Customer or Patient has a valid consent, then the Relay experience will be sent regardless if this is a new onboard or if an existing Customer or Patient is being updated.

    If a Client has mobile analysis and strict onboarding enabled, for all phone numbers that are not considered as type “mobile”, the onboarding process will include the record in the reject file, indicating that the specific number is non-mobile and was not included on the Customer or Patient account.

    Data File Properties: Onboarding

    Property

    Data Type

    Length

    Required

    Description

    ccid

    string

    100

    Yes

    The unique identifier of the Customer.

    phone_number

    string

    10

    Yes

    The phone number associated with the Customer or Patient expressed only using numeric values.

    product_group

    string

    100

    Yes

    The current product group identifier of the Customer. An account is associated to one and only one product group at a time.

    consent_type

    string

    100

    Yes

    Specifies the type of consent assigned to Customer's or Patient's phone number.

    Valid values are:

      written    The phone number will have express written consent.

      express   The phone number will have express consent.

    trigger_id

    string

    100

    No

    The unique Trigger identifier that was the originating source of the event.

    deactivate_previous_connections

    boolean

    N/A

    No

    This processing flag is used to control how existing phone numbers, for an existing Customer or Patient, should be treated.

    trueAll existing connections will be removed prior to onboarding the new data.
    falseExisting connections will not be removed prior to onboarding. If onboarding with a new mobile number it will be added to the list of existing connections.

    secondary_account_id

    string

    100

    No

    This field can be used to tie the Customer back to another external system.

    first_name

    string

    100

    No

    The first name of the Customer or Patient.

    middle_name

    string

    100

    No

    The middle name of the Customer or Patient.

    last_name

    string

    100

    No

    The last name of the Customer or Patient.

    address1

    string

    100

    No

    Identifies the first line of the Customer's or Patient's address.

    address2

    string

    100

    No

    Identifies the second line of the Customer's or Patient's address.

    city

    string

    100

    No

    Identifies the city of the Customer's or Patient's address.

    state_province

    string

    2

    No

    Identifies the state or province of the Customer's or Patient's address.

    postal_code

    string

    10

    No

    Identifies the postal code of the Customer's or Patient's address.

    date_of_birth

    date

    No

    Identifies the date of birth of the Customer or Patient.

    Format: yyyy-mm-dd

    ssn_last4

    string

    4

    No

    The last 4 digits of the Customer's or Patient's social security number.

    gender

    string

    1

    No

    Identifies the gender of the Customer or Patient.

    ext_xxx

    string

    100

    No

    Client defined, extensible properties to be stored with the Customer or Patient record. Each extensible property must be defined with a prefix "ext_".

    • Custom ext_ properties are provided by the Client.
    • Zero or more ext_ properties can be provided.
    • Different ext_ properties can be provided for each Customer or Patient.
    • The maximum length of each ext_ property is 100 characters.

    EXT_LANG

    string

    100

    No

    This field can be used to designate whether the users's feed should be in English or Spanish.  The header is case sensitive.  Please work with your Relay Account team to ensure you have Spanish feed settings enabled as well.

    Values

    ES The user's feed should be in Spanish

    EN or Null The user's feed should be in English

    input_xxx

    string

    100

    No

    Input parameters to be used in the experience. Each input parameter is prefixed with "input_" followed by the input parameter name.

    • Custom input parameters are provided by the Client.
    • Zero or more input_ parameters can be specified.
    • Different input_ parameters can be specified on each row in the file.
    • The maximum length of each input_ parameter is 100 characters.

    client_message_tag

    string

    100

    No

    An optional, Client created, tag that was provided during the initial messaging/onboarding request.

    lb_name

    string

    255

    No

    Launched by name. If set, identifies the name of the user that triggered the notification.

    lb_source

    string

    255

    No

    Launched by source. If set, identifies the source system that triggered the notification.

    Was this article helpful?
    What's Next
    ESC

    Eddy AI, facilitating knowledge discovery through conversational intelligence