v22

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

Contacts API

Create a contact

post/public/api/v1/inboxes/{inbox_identifier}/contacts

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

source_idstring

The session identifier 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

pubsub_tokenstring

The token to be used to connect to chatwoot websocket

All 12 operations