Contacts

Update contact properties

Each contact in Tidio can have a set of defined properties.

It is important to note that contacts are website visitors who have interacted with the Tidio widget and have been identified by their name, email address, or phone number.

These properties include email, first_name, last_name, phone, distinct_id, and properties. Each property has a specific type, such as text, email, number, phone, or URL. Please note that you can only update contacts that are already defined in the Tidio panel.

Pass only the property you want to update.

  1. When the property equals null, it is going to be cleared.
  2. When a property does not exist in the body, it stays untouched.
  3. Passing any non-existing property will result in a validation error.
  4. Passing the wrong property type will result in a validation error.
patch/contacts/{contactId}

Request

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

Path parameters

contactIdstring uuid required

ID of the contact

Example:a1b4ca4c-1108-4432-b256-1e4cf2bf6f9e

Request body

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

distinct_idstring

ID of the contact in external system

Example request

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

Response

It means that the contact has been updated.

Changes

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