Pular para o conteúdo principal
DELETE
Cancelar mensagem agendada
Use este endpoint para cancelar uma mensagem que ainda não foi enviada. Só é possível cancelar mensagens com status scheduled ou pending. Se a mensagem já foi enviada, falhou ou já está cancelada, a API retorna erro 422. Ao cancelar, o status da mensagem muda para canceled e o campo canceled_at é preenchido com a data e hora do cancelamento.
O cancelamento é definitivo. Não é possível “descancelar” uma mensagem. Se precisar reenviá-la, crie uma nova.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

id
string
obrigatório

ID da mensagem no formato msg_xxxx

Resposta

Mensagem cancelada com sucesso

id
string

ID da mensagem cancelada

Exemplo:

"msg_k7m2nxp9q4"

status
enum<string>

Novo status da mensagem

Opções disponíveis:
canceled
Exemplo:

"canceled"