v22

latestOpenAPI 3.1.0MIT Licenseraw.githubusercontent.com2026-08-0312123228.9 KB

Contacts API

Update a contact

Update a contact's attributes

patch/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}

Request body

identifierstring

External identifier of the contact

identifier_hashstring

Identifier hash prepared for HMAC authentication

emailstring

Email of the contact

namestring

Name of the contact

phone_numberstring

Phone number of the contact

avatarstring binary

Send the form data with the avatar image binary or use the avatar_url

custom_attributesobject

Custom attributes of the customer

Example request

{
  "identifier": "1234567890",
  "identifier_hash": "e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9",
  "email": "alice@acme.inc",
  "name": "Alice",
  "phone_number": "+123456789",
  "custom_attributes": {}
}

Response

Success

idinteger

Id of the contact

namestring nullable

Name of the contact when available

emailstring nullable

Email of the contact

phone_numberstring nullable

Phone number of the contact

identifierstring nullable

Identifier of the contact

blockedboolean

Whether the contact is blocked

additional_attributesobject nullable

Additional attributes of the contact when present

custom_attributesobject nullable

Custom attributes of the contact when present

contact_typestring nullable

Contact type of the contact when available

country_codestring nullable

Country code of the contact

last_activity_atstring nullable

Last activity timestamp of the contact in ISO 8601 format

created_atstring nullable

Created timestamp of the contact in ISO 8601 format

updated_atstring nullable

Updated timestamp of the contact in ISO 8601 format

last_namestring nullable

Last name of the contact

middle_namestring nullable

Middle name of the contact

locationstring nullable

Location of the contact

account_idinteger

Account id of the contact

company_idinteger nullable

Company id of the contact

label_liststring[]

Labels applied to the contact