Forget a channel's connection and stored credentials, with no undo
Forget this workspace's connection for a channel. Inbound messages already landed keep their tickets.
/v1/channels/{channel}Admin- Operation id
- delete_channel_connection
- Access
- An editor or a viewer is refused.
/v1/channels/{channel}Forget this workspace's connection for a channel. Inbound messages already landed keep their tickets.
The stored configuration is deleted, including any credential in it, and
there is no undo. To stop a channel without losing its configuration, save
it with enabled: false instead.
A channel that is not connected is 404 channel_not_found, so a 204 always
means a connection really was removed.
There is no response body.
Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.
Authorisation: admin or owner. An editor or viewer receives 403 insufficient_role.
Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the channels:write scope, and the workspace role of the person who owns it must meet the floor above.
A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/v1/channels/string"