ConversationsChannels

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.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
descriptionstringRequired
A description of the channel
modalityenumRequired
The modality of the channel
Allowed values:
namestringRequired
The name of the channel
metadatamap from strings to strings or booleans or integers or doublesOptional

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)

Response

Channel created
descriptionstring
A description of the channel
modalityenum
The modality of the channel
Allowed values:
namestring
The name of the channel
created_atstringRead-onlyformat: "date-time"
The date and time the channel was created
idstringRead-onlyformat: "id"
The channel ID
metadatamap from strings to strings or booleans or integers or doubles

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)
typeenumRead-only
The type of the channel
Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
413
Content Too Large Error
429
Too Many Requests Error
500
Internal Server Error