Skip to main content
POST
Create or update contact

Authorizations

X-API-Key
string
header
required

Preferred. API key value directly.

Query Parameters

channelId
string

Channel id. Auto-selects the first active channel when omitted.

Example:

"ch_123"

phoneNumber
string

Contact phone, digits with optional leading +.

Example:

"919876543210"

name
string

Display name. Defaults to phoneNumber on create.

email
string

Contact email.

Example:

"john@acme.com"

profilePictureUrl
string

Avatar URL.

customFieldsData
object

Map of custom field values, or "k:v,k:v" string. Keys resolve case-insensitively.

Example:
labelNames
any[]

Labels to set. Accepts array, comma string, or label alias.

Example:

Body

application/json
phoneNumber
string
required

Contact phone, digits with optional leading +.

Example:

"919876543210"

channelId
string

Channel id. Auto-selects the first active channel when omitted.

Example:

"ch_123"

name
string

Display name. Defaults to phoneNumber on create.

email
string

Contact email.

Example:

"john@acme.com"

profilePictureUrl
string

Avatar URL.

customFieldsData
object

Map of custom field values, or "k:v,k:v" string. Keys resolve case-insensitively.

Example:
labelNames
any[]

Labels to set. Accepts array, comma string, or label alias.

Example:

Response

Success. Envelope: { success:true, data, message? }.

success
boolean
required
Example:

true

data
any
message
string
pagination
object
total
number
Last modified on September 20, 2026