Skip to main content
POST
/
public
/
contacts
Create a contact
curl --request POST \
  --url https://web-api.clerk.chat/public/contacts \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '
{
  "name": "John Doe",
  "email": "johndoe@example.com",
  "phone": "+1234567890",
  "public": false,
  "data": {}
}
'
{
  "data": {
    "id": "1",
    "teamId": "1",
    "createdByUserId": "1",
    "name": "John Doe",
    "phone": "+1234567890",
    "email": "johndoe@example.com",
    "externalId": "1234",
    "optOut": false,
    "avatarURL": "https://example.com/avatar.jpg",
    "public": false,
    "data": {},
    "attributes": [],
    "created": "2021-01-01T00:00:00.000Z",
    "updated": "2021-01-01T00:00:00.000Z"
  }
}

Authorizations

​
apiKey
string
header
required

Body

application/json
​
name
string

The name of the contact

Example:

"John Doe"

​
email
string

The email address of the contact

Example:

"johndoe@example.com"

​
phone
string

The phone number of the contact

Example:

"+1234567890"

​
public
boolean

Whether the contact is public

Example:

false

​
data
object

Additional metadata for the contact

Example:
{}

Response

The created contact

​
data
object
required