Skip to main content
POST
Cancelar uma campanha
Só campanhas com status PENDING ou IN_PROGRESS podem ser canceladas. Qualquer outro status responde 400. O cancelamento fecha os destinatários que ainda não saíram: quem está PENDING passa a CANCELLED. Quem já foi disparado não é afetado — uma mensagem entregue não volta atrás.
Em campanhas de WhatsApp o cancelamento é aplicado pelo serviço de mensagens, que é o dono das regras de disparo. O efeito para você é o mesmo, e os erros 502 e 503 existem só nesse canal.

Exemplo

Erros

Cancelar uma campanha em andamento não interrompe uma mensagem já enviada, mas evita todas as que ainda não saíram. Quanto antes você cancelar, menos quota da Meta é consumida.

Authorizations

Authorization
string
header
required

API Key da organização (Authorization: Bearer ik_live_xxx)

Path Parameters

id
string
required

ID da campanha

Response

Campanha cancelada

id
string
required
status
string
required
message
string
required