API Referencechannels

Update

Update a channel in your organization.

Authentication

Authorizationstring
API Key authentication via header

Path Parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
namestringOptional<=255 charactersDefaults to
The name of the channel.
participantslist of objectsOptional
Participants in the channel.
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:

Errors