curl --request DELETE \
--url https://api.omni.z-api.io/v1/channels/{channelId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cancelReason": "Cliente encerrou a empresa"
}
'Canais
Remover canal
Exclua um canal 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": "Cliente encerrou a empresa"
}
'Conceituação
Exclui um canal. Depois de excluído, o canal deixa de poder ser usado, e não é possível desfazer a exclusão pela API.Condições para exclusão
A exclusão só é permitida quando o canal está desconectado e não possui assinatura ativa. Com o canal conectado, a API responde422 com INSTANCE_STILL_CONNECTED. A tabela abaixo descreve o comportamento por status:
| Status | Exclusão permitida | Observação |
|---|---|---|
| Trial | Sim | — |
| Pendente | Sim | Se houver fatura aberta, ela será cancelada automaticamente |
| Pago | Não | O canal deve ser cancelado antes de ser excluído |
| Em processo de cancelamento | Não | O canal deve ser cancelado antes de ser excluído |
| Cancelado | Sim | — |
A exclusão não pode ser desfeita pela API. Para excluir um canal com assinatura ativa, primeiro cancele a assinatura via Cancelar assinatura e aguarde o status
CANCELED.Erro 502
Se a exclusão falhar no serviço interno, a API responde 502 com o corpo abaixo, sem detalhes internos. Tente novamente e, se o erro persistir, fale com o suporte.
{
"error": "integration_unavailable",
"message": "The operation could not be completed right now. Try again in a few moments."
}
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"
Corpo
application/json
Motivo da exclusão (opcional, mas recomendado para auditoria)
Exemplo:
"Cliente encerrou a empresa"
Resposta
Canal excluído com sucesso. Nenhum conteúdo retornado.