Skip to main content
POST
Add a custom channel to a contact

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

Org ID

contact_id
string
required

Contact ID

Body

Schema for adding a custom channel to an existing contact. At least one field must be provided.

name
string | null

The name for the contact channel

Maximum string length: 256
email
string<email> | null

The email for the contact channel

Maximum string length: 256
phone
string | null

The phone number for the contact channel

Maximum string length: 256
username
string | null

The username for the contact channel

Maximum string length: 256

Response

200 - application/json

Schema for the contact channel

id
string
required
type
enum<string>
required

ID of the connection integration

Available options:
internal,
org,
custom,
whatsapp_bot,
messenger_bot,
instagram_dm,
tiktok_dm,
telegram_bot,
gmail,
slack_bot,
twilio,
telnyx,
email
user_id
string
required

The unique identifier for the contact channel, e.g Phone Number or User ID

avatar
string | null
required

The avatar for the contact channel, e.g X Avatar URL

name
string | null
required

The name for the contact channel, e.g Full Name

username
string | null
required

The username for the contact channel, e.g Username

email
string | null
required

The email for the contact channel, e.g Email

phone
string | null
required

The phone number for the contact channel, e.g Phone Number

country
string | null
required

The country code associated with the contact channel, e.g US for United States

agent
string | null
required

The user agent associated with the contact channel

ip
string | null
required

The IP address associated with the contact channel

language
string | null
required

The language code associated with the contact channel, e.g en for English

platform_data
object
required

Schema for the platform-specific data of a contact channel

created_at
string<date-time>
required
updated_at
string<date-time>
required

A link to the contact channel, e.g a link to the social media profile