curl --request DELETE \
--url https://api.omni.z-api.io/v1/channels/{channelId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cancelReason": "Customer closed the company"
}
'Channels
Delete channel
Permanently delete a channel via API
DELETE
/
v1
/
channels
/
{channelId}
curl --request DELETE \
--url https://api.omni.z-api.io/v1/channels/{channelId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cancelReason": "Customer closed the company"
}
'Overview
Permanently removes a channel and all its data. Deletion is irreversible — the channel is physically removed from the system.Conditions for deletion
Deletion is only allowed when the channel has no active subscription. The table below describes the behavior by status:| Status | Deletion allowed | Notes |
|---|---|---|
| Trial | Yes | — |
| Pending | Yes | If there is an open invoice, it will be automatically cancelled |
| Paid | No | The channel must be cancelled before it can be deleted |
| Cancellation in progress | No | The channel must be cancelled before it can be deleted |
| Cancelled | Yes | — |
Deletion is permanent and irreversible. To delete a channel with an active subscription, first cancel the subscription via Cancel subscription and wait for the
CANCELED status.The
channelId is obtained from the Create channel endpoint.Authorizations
Secret Key generated in the Omni Z-API Security panel
Path Parameters
Channel ID (obtained via Create channel)
Example:
"019E4C54B1B375A28970B605CA9B03C3"
Body
application/json
Reason for deletion (optional, but recommended for auditing)
Example:
"Customer closed the company"
Response
Channel deleted successfully. No content returned.