Skip to main content
POST
Add channel to contact

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

contactId
string
required

Body

application/json

Request body to add a channel to a contact.

channel
enum<string>
required

Channel type.

Available options:
sms,
whatsapp,
email,
telegram,
instagram,
messenger,
voice
identifier
string
required

Channel identifier (phone number in E.164 format or email address).

Example:

"+14155551234"

countryCode
string

ISO country code for phone numbers.

Required string length: 2
Example:

"US"

label
string

Optional label for the channel.

Maximum string length: 50
Example:

"work"

isPrimary
boolean
default:false

Whether this should be the primary channel for its type.

Response

Channel added.

channel
object
required

A communication channel for a contact.