Skip to main content
PATCH
/
orgs
/
{org_id}
/
contacts
/
{contact_id}
/
channels
/
{channel_id}
Update a contact channel (only for custom channels)
curl --request PATCH \
  --url https://api.example.com/orgs/{org_id}/contacts/{contact_id}/channels/{channel_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel_name": "<string>",
  "channel_display_name": "<string>",
  "channel_avatar": "<string>"
}
'
{
  "id": "<string>",
  "channel_type": "internal",
  "channel_id": "<string>",
  "channel_name": "<string>",
  "channel_display_name": "<string>",
  "channel_avatar": "<string>",
  "country": "<string>",
  "agent": "<string>",
  "ip": "<string>",
  "language": "<string>",
  "platform_data": {},
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25",
  "link": "<string>"
}

Path Parameters

​
org_id
string
required
​
contact_id
string
required
​
channel_id
string
required

Body

Schema for updating a contact channel

​
channel_name
string | null

The display name for the contact channel, e.g Username

​
channel_display_name
string | null

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

​
channel_avatar
string | null

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

Maximum string length: 2048

Response

200 - application/json

Schema for the contact channel

​
id
string
required
​
channel_type
enum<string>
required

ID of the connection integration

Available options:
internal,
custom,
whatsapp_bot,
messenger_bot,
instagram_dm,
twilio,
slack_bot,
telegram_bot,
gmail,
google_calendar
​
channel_id
string
required

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

​
channel_name
string | null
required

The display name for the contact channel, e.g Username or Email

​
channel_display_name
string | null
required

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

​
channel_avatar
string | null
required

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

​
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>
required
​
updated_at
string<date>
required
​
link
string

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