curl --request DELETE \
--url https://api.omni.z-api.io/v1/channels/{channelId}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cancelReason": "Cliente encerrou a empresa"
}
'{
"error": 400,
"message": "cancel query param is required"
}{
"error": 401,
"message": "Unauthorized"
}{
"error": 404,
"message": "Channel not found"
}{
"error": 422,
"message": "This action requires ENTERPRISE role"
}Canais
Cancelar assinatura
Cancele a assinatura de um canal programaticamente
DELETE
/
v1
/
channels
/
{channelId}
/
cancel
curl --request DELETE \
--url https://api.omni.z-api.io/v1/channels/{channelId}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cancelReason": "Cliente encerrou a empresa"
}
'{
"error": 400,
"message": "cancel query param is required"
}{
"error": 401,
"message": "Unauthorized"
}{
"error": 404,
"message": "Channel not found"
}{
"error": 422,
"message": "This action requires ENTERPRISE role"
}Conceituação
Solicita o cancelamento da assinatura de um canal. O cancelamento não é imediato — o canal entra no statusCANCELLATION_PROCESS e permanece ativo até o fim do período já pago. Após esse período, o status muda para CANCELED.
O parâmetro de query cancel=true é obrigatório como confirmação explícita do cancelamento.
O campo cancelReason no body é opcional, mas recomendado para fins de auditoria.
Status após o cancelamento
| Status | Descrição |
|---|---|
CANCELLATION_PROCESS | Cancelamento solicitado, canal ainda ativo até o fim do período |
CANCELED | Canal efetivamente cancelado e desativado |
O cancelamento não pode ser desfeito via API. Para reativar o canal, é necessário iniciar uma nova assinatura via Assinar canal.
O
channelId é obtido através do endpoint Criar canal.Autorizações
Secret Key gerada no painel de Segurança do Omni Z-API
Parâmetros de caminho
ID do canal (obtido via Criar canal)
Exemplo:
"019E4C54B1B375A28970B605CA9B03C3"
Parâmetros de consulta
Deve ser true para confirmar o cancelamento
Exemplo:
true
Corpo
application/json
Motivo do cancelamento (opcional, mas recomendado para auditoria)
Exemplo:
"Cliente encerrou a empresa"
Resposta
Cancelamento solicitado com sucesso. Nenhum conteúdo retornado.