Skip to main content

Create contacts

POST 
/v3/contacts/batch

Create contacts

Request​

Body

array

  • Array [

    • full_name string

    Possible values: <= 255 characters

    Full Name of contact

    email string

    Possible values: <= 255 characters

    Email of contact. Can be optional only if anonymous contact feature is enabled.

    phone string

    Possible values: <= 255 characters

    Phone number of the contact

    mobile string

    Possible values: <= 255 characters

    Mobile number of the contact

    job_title string

    Possible values: <= 255 characters

    Job Title of the contact

    contact_type string

    Possible values: [contact, employee]

    Default value: contact

    Type of contact

    contact_list_ids number[]

    Possible values: >= 1, <= 100

    List ids to which the contact should be added

    referenceId string

    Possible values: <= 255 characters

    Reference ID of the anonymous contact

    unique_id string

    Possible values: <= 255 characters, Value must match regular expression /^[a-zA-Z0-9]+$/

    Unique ID of the contact

    unsubscribed boolean

    Unsubscribed status of the contact

    unsubscribe_text string

    Possible values: <= 255 characters

    Reason for unsubscribing

  • ]

Responses​

Accepted

Schema

    message string

    The contacts have been successfully created

    token string

    The token will be used for getting status of contacts

Loading...