Pular para o conteúdo principal

​
Cancelar Envios Agendados

DELETE https://pilotstatus.com.br/v1/messages/cancel
Cancela o agendamento de uma ou mais mensagens que ainda estão na fila para envio futuro (QUEUED com deliverAt / deliverBy no futuro). A linha da mensagem não é excluída: o status passa a ser CANCELED, e os Logs + o histórico de rastreamento permanecem.
CANCELED não é FAILED e não é um dos valores de errorCode de erro de entrega listados em Códigos de Erro de Log.

​
Cabeçalhos

  • Content-Type: application/json
  • x-api-key: ps_... (ou x-api-key-id) — a mesma chave de POST /v1/messages/send

​
Corpo

​
messageIds
string[]
obrigatório
Até 100 IDs de mensagem por requisição.
{ "messageIds": ["<id1>", "<id2>"] }

​
Exemplo

curl -X DELETE "https://pilotstatus.com.br/v1/messages/cancel" \
  -H "Content-Type: application/json" \
  -H "x-api-key: ps_your_key_here" \
  -d '{ "messageIds": ["msg_abc", "msg_def"] }'
Este endpoint usa DELETE com um corpo JSON; curl, fetch e a maioria dos clientes HTTP oferecem suporte a isso.

​
Resposta (200)

  • Apenas mensagens que ainda podem ser agendadas aparecem em cancelled; as demais são listadas em failed com um reason.
  • Após o cancelamento, GET /v1/messages/{messageId} retorna "status": "CANCELED".
  • A página de Logs oferece suporte ao mesmo fluxo por meio da seleção em massa de linhas agendadas.

​
Erros comuns

  • 400 — validação do corpo (por exemplo, messageIds ausente, mais de 100 IDs).
  • 401 — cabeçalho de chave de API ausente/inválido.
  • 403 — por exemplo, uma chave com escopo de tenant em um endpoint com escopo de número.