Contacts

Create contact

Contacts are site visitors who have interacted with the Tidio widget and have been identified by their name, email address, or phone number.

Each contact can have custom properties that can be given by the contact, added by chat operators, or updated by chatbots. Contacts may also have conversations, which include messages from the contact as well as messages to the contact from chat operators or chatbots.

You can use OpenAPI to create a new contact. When creating a contact, you need to provide at least one of the following: email, first_name, last_name, or phone.

Please note that using this method will always add new contacts. No data will be overwritten, even if it includes the email or a distinct_id.

post/contacts

Request

  • Base URL
    https://api.tidio.com
  • URL
    https://api.tidio.com/contacts
  • Auth
    API key in header X-Tidio-Openapi-Client-Id and API key in header X-Tidio-Openapi-Client-Secret

Request body

distinct_idstring required

ID of the contact in external system

emailstring email nullable

Email address of the contact [RFC822]

phonestring nullable

Phone number of the contact

first_namestring nullable

First name of the contact

last_namestring nullable

Last name of the contact

email_consent'subscribed' | 'unsubscribed' nullable

This field indicates if contact agreed to newsletter subscription

Example request

{
  "distinct_id": "123456",
  "email": "email@example.com",
  "phone": "123 456 789",
  "first_name": "John",
  "last_name": "Doe",
  "email_consent": "subscribed",
  "properties": [
    {
      "name": "shoe_size",
      "value": "44 (EU)"
    }
  ]
}

Response

Entity was created and their id is returned

idstring uuid

Example response

{
  "id": "a1b4ca4c-1108-4432-b256-1e4cf2bf6f9e"
}

Changes

No recorded changes to this operation across all 1 revision of this API.