Remover canal

Remova permanentemente um canal via API

DELETE /v1/channels/{channelId}

cURL

withReason

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"
}
'

204

​

Conceituação

Remove permanentemente um canal e todos os seus dados. A exclusão é irreversível — o canal é fisicamente removido do sistema.

​

Condições para exclusão

A exclusão só é permitida quando o canal não possui assinatura ativa. 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 é permanente e irreversível. Para excluir um canal com assinatura ativa, primeiro cancele a assinatura via Cancelar assinatura e aguarde o status CANCELED.

O channelId é obtido através do endpoint Criar canal.

Autorizações

Authorization · string · header · obrigatório

Secret Key gerada no painel de Segurança do Omni Z-API

Parâmetros de caminho

channelId · string · obrigatório

ID do canal (obtido via Criar canal)

Exemplo:

"019E4C54B1B375A28970B605CA9B03C3"

Corpo

application/json

cancelReason · string

Motivo da exclusão (opcional, mas recomendado para auditoria)

Exemplo:

"Cliente encerrou a empresa"

Resposta

204

Canal excluído com sucesso. Nenhum conteúdo retornado.