API Referencechannels

Create

Create a new channel with initial participants.

Channel creation and initial participant assignment are coupled here as a channel requires participants to be meaningful. Further participant management should use POST /channels/{id}/participants.

Authentication

Authorizationstring
API Key authentication via header

Request

This endpoint expects an object.
typeenumRequired
The type of communication used for the channel.
Allowed values:
namestringRequired<=255 characters
The name of the channel.
participantslist of objectsRequired
Participants in the channel. Must include at least one agent and one user.
channel_typeenum or nullOptional
The type of channel.
Allowed values:
sourceenum or nullOptional
Which application created the channel.
Allowed values:
meta_datamap from strings to any or nullOptional

Response

Successful Response
idstringformat: "uuid"
The ID of the channel.
typeenum
The type of communication used for the channel.
Allowed values:
channel_typeenum
The type of channel.
Allowed values:
namestring
The name of the channel.
participantslist of objects
Participants in the channel.
created_atstringformat: "date-time"
When the channel was created.
modifiedstringformat: "date-time"
When the channel was last modified.
meta_datamap from strings to any or null
sourceenum or null
Which application created the channel.
Allowed values:
agent_invocation_behaviorenum or null
Defines the response behavior of agents in channels.
Allowed values:

Errors