Skip to main content
POST
Link a channel identity to a customer

Authorizations

Authorization
string
header
required

Use a workspace API key in the Authorization header. Keys use pk_live_<key_id> for production and pk_test<key_id>_ for test mode.

Path Parameters

customerId
string
required

Body

application/json
channel
string
required

Channel the identity belongs to (open string, e.g. whatsapp, slack, email).

Example:

"whatsapp"

identifier
string
required

The identity value on that channel.

Example:

"+628123456789"

verified
boolean
default:false

True asserts your system authenticated this identity, allowing auto-merge. Recorded with verifiedAt.

claimedEmail
string

A claimed (unverified) email; display and merge-suggestion input only.

displayName
string
avatarUrl
string
primary
boolean
default:false

Response

Created channel identity.

id
string
required
Example:

"cid_x6q5vl75f5d53m7oet2k4r5w6a"

customerId
string
required
channel
string
required
Example:

"whatsapp"

identifier
string
required
Example:

"+628123456789"

verified
boolean
required
primary
boolean
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
verifiedAt
string<date-time> | null
claimedEmail
string | null
displayName
string | null
avatarUrl
string | null
lastActiveAt
string<date-time> | null