Create a contact

POST 
/v3/contacts

Create a contact

Request

application/json

Body

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

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

200

Successful

*/*

Schema

Schema

data

object

full_name string

Possible values: <= 255 characters

Full Name of contact

email string

Email of contact

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

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

Example (from schema)

{
  "data": {
    "full_name": "Jane Doe",
    "email": "[email protected]",
    "phone": "91234567833",
    "mobile": "1653452783",
    "job_title": "Manager",
    "contact_type": "contact",
    "referenceId": "123456",
    "unique_id": "abc123",
    "unsubscribed": false,
    "unsubscribe_text": "Not interested"
  }
}

Loading...