Skip to main content
PATCH
Update channel

Authorizations

Authorization
string
header
required

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

Path Parameters

contactId
string
required
channelId
string
required

Channel ID.

Body

application/json

Request body to update a channel.

label
string | null

Optional label for the channel. Set to null to clear.

Maximum string length: 50
verified
boolean

Whether the channel is verified.

metadata
object

Response

Channel updated.

channel
object
required

A communication channel for a contact.