ConversationsChannels

Update a channel

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

Authentication

AuthorizationBearer

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

Path parameters

channel_idstringRequiredformat: "id"
The ID of the channel to update

Request

This endpoint expects an object.
capabilitiesobjectRequired

Capabilities to update. Only the fields you include are changed; omitted fields keep their current value.

Response

Channel updated
descriptionstring
A description of the channel
modalityenum
The modality of the channel
namestring
The name of the channel
capabilitiesobjectOptional

What the channel’s surface can render. The AI Agent tailors replies to the declared capabilities. Omitted fields default to false. Read-only on native channels, whose capabilities are fixed by the surface.

created_atstringOptionalRead-onlyformat: "date-time"
The date and time the channel was created
idstringOptionalRead-onlyformat: "id"
The channel ID
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)
typeenumOptionalRead-only
The type of the channel

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error