Delete a Channel.
DELETE /api/v1/forward/channels/{channel_id}
Deletes a Channel that is no longer needed.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or SAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
channel_id | string | Yes | Channel ID. Same value as the Channel object's id. |
Example request
Example response
HTTP 200 OK
Response fields
| Field | Type | Description |
|---|---|---|
id | string | Deleted Channel ID. |
deleted | boolean | Whether deletion succeeded. Always true on success. |
Deletion rules
- After deletion, the Channel no longer processes inbound messages, cannot continue QR binding, and cannot send channel replies.
- Deletion is irreversible. To pause inbound processing temporarily, use Update Channel with
enabled=false.
Error codes
| HTTP | Type | Trigger |
|---|---|---|
| 401 | authentication_error | PAT or SAT is invalid, expired, or missing. |
| 404 | not_found_error | Channel does not exist or is not visible to the caller. |
| 502 | api_error | Channel deletion failed. |