Skip to main content
POST
/
public
/
api
/
v1
/
inboxes
/
{inbox_identifier}
/
contacts
Create a contact
curl --request POST \
  --url https://app.chatwoot.com/public/api/v1/inboxes/{inbox_identifier}/contacts \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": "1234567890",
  "identifier_hash": "e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9",
  "email": "alice@acme.inc",
  "name": "Alice",
  "phone_number": "+123456789",
  "avatar": "<string>",
  "custom_attributes": {}
}
'
{
  "id": 123,
  "source_id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "pubsub_token": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developers.chatwoot.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
inbox_identifier
string
required

The identifier obtained from API inbox channel

Body

application/json
​
identifier
string

External identifier of the contact

Example:

"1234567890"

​
identifier_hash
string

Identifier hash prepared for HMAC authentication

Example:

"e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9"

​
email
string

Email of the contact

Example:

"alice@acme.inc"

​
name
string

Name of the contact

Example:

"Alice"

​
phone_number
string

Phone number of the contact

Example:

"+123456789"

​
avatar
file

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

​
custom_attributes
object

Custom attributes of the customer

Example:
{}

Response

Success

​
id
integer

Id of the contact

​
source_id
string

The session identifier of the contact

​
name
string

Name of the contact

​
email
string

Email of the contact

​
pubsub_token
string

The token to be used to connect to chatwoot websocket