Skip to navigation
Runtime API TemplateChannels

Close a channel

Authentication

AuthorizationBearer

OAuth/JWT bearer with the ‘runtime’ scope that resolves to a user principal. API keys and agent service tokens are rejected by user-delegated operations.

Path parameters

channelIdstringRequired
Channel id.

Headers

X-CES-Workspace-IDstringOptionalformat: "^ws_[A-Za-z0-9_-]+$"
Optional Workspace runtime selector header. If supplied with workspaceId, both values must match.

Query parameters

agentIdstringOptional
Optional agent participant id filter within this app.
workspaceIdstringOptionalformat: "^ws_[A-Za-z0-9_-]+$"

Optional Workspace runtime selector for preview or validation calls. If supplied with X-CES-Workspace-ID, both values must match.

Response

Channel closed
closedboolean

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error