Contents x
    Create Customer/Patient
    • 19 Nov 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    Create Customer/Patient

    • Updated on 19 Nov 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Post
    /cdm/client/{client_id}/load-customer-record

    This API is used to add a Customeror or Patient to the Relay platform.

    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
    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
    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 - The Customer or Patient was successfully loaded.

    object
    ExampleAccepted
    400

    Bad Request - There was an issue with the request. The response body will contain additional information related to the bad request.

    401

    Unauthorized - The API token does not have authorization to the requested resource.

    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 Customer or Patient, but the ID already exists in the system.

    500

    Server Error - 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