channels

Update a channel

Update a channel's capabilities. Only custom channels can be updated; native channels are read-only.

patch/v2/channels/{channel_id}

Request

  • Base URL: https://example.ada.support/api
  • URL: https://example.ada.support/api/v2/channels/{channel_id}
  • Auth: HTTP bearer

Path parameters

channel_idstring id required

The ID of the channel to update

Request body

Response

Channel updated

idstring id

The channel ID

type'custom'

The type of the channel

namestring required

The name of the channel

descriptionstring required

A description of the channel

modality'messaging' | 'email' | 'voice' | 'sms' required

The modality of the channel

metadataobject

A dictionary of key, value pairs assigned to the channel. Metadata may not exceed 4KB total.

  • metadata keys may only be of type: string
  • metadata values may only be one of type: string, boolean, integer, or number (float)
created_atstring date-time

The date and time the channel was created

Changes

No recorded changes to this operation across all 1 revision of this API.