channels

Create a new channel

Create a new channel. A maximum of 100 channels can be created per account per day. The maximum request size is 10MB.

post/v2/channels/

Request

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

Request body

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

Response

Channel created

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.