Create a contact

POST

public

contacts

curl --request POST \
  --url https://web-api.clerk.chat/public/contacts \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '{
  "name": "John Doe",
  "phone": "+1234567890",
  "email": "johndoe@example.com",
  "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"

phone

string

The phone number of the contact

Example:

"+1234567890"

string

The email address of the contact

Example:

"johndoe@example.com"

public

boolean

Whether the contact is public

Example:

false

data

object

Additional metadata for the contact

Example:

{}

Response

201

application/json

The created contact

data

object

required

data.id

string

required

The ID of the contact

Example:

"1"

data.teamId

string

required

The ID of the team the contact belongs to

Example:

"1"

data.createdByUserId

string

required

The ID of the user who created the contact

Example:

"1"

data.name

string

required

The name of the contact

Example:

"John Doe"

data.phone

string

required

The phone number of the contact

Example:

"+1234567890"

data.email

string

required

The email address of the contact

Example:

"johndoe@example.com"

data.externalId

string

required

The external ID of the contact

Example:

"1234"

data.optOut

boolean

required

Whether the contact has opted out of messages

Example:

false

data.avatarURL

string

required

The URL of the contact avatar

Example:

"https://example.com/avatar.jpg"

data.public

boolean

required

Whether the contact is public

Example:

false

data.data

object

required

Additional metadata for the contact

Example:

{}

data.attributes

object[]

required

The contact attributes

Example:

[]

data.created

string

required

Example:

"2021-01-01T00:00:00.000Z"

data.updated

string

required

Example:

"2021-01-01T00:00:00.000Z"

Search for a contact Update 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",
  "phone": "+1234567890",
  "email": "johndoe@example.com",
  "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"
  }
}

Public

Public Admin

Authorizations

Body

Response