Pular para o conteúdo principal
DELETE
/
v1
/
channels
/
{channelId}
/
cancel
curl --request DELETE \
  --url https://api.hubmessage.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"
}

​
Conceituação

Solicita o cancelamento da assinatura de um canal. O cancelamento não é imediato — o canal entra no status CANCELLATION_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.
Este endpoint requer a role ENTERPRISE na sua conta.

​
Status após o cancelamento

StatusDescrição
CANCELLATION_PROCESSCancelamento solicitado, canal ainda ativo até o fim do período
CANCELEDCanal 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

​
Authorization
string
header
obrigatório

Secret Key gerada no painel de Segurança do Hub Message

Parâmetros de caminho

​
channelId
string
obrigatório

ID do canal (obtido via Criar canal)

Exemplo:

"019E4C54B1B375A28970B605CA9B03C3"

Parâmetros de consulta

​
cancel
boolean
obrigatório

Deve ser true para confirmar o cancelamento

Exemplo:

true

Corpo

application/json
​
cancelReason
string

Motivo do cancelamento (opcional, mas recomendado para auditoria)

Exemplo:

"Cliente encerrou a empresa"

Resposta

Cancelamento solicitado com sucesso. Nenhum conteúdo retornado.