ARararahq
Opt-out

Registrar opt-out

Changed on

Registra que o telefone não quer mais receber mensagens da organização. Registrar o mesmo telefone de novo devolve o registro existente.

Atenção: o envio hoje só é bloqueado por opt-out feito por palavra-chave recebida no WhatsApp (ex. "SAIR", "PARAR", "STOP"). O opt-out registrado por esta rota ou pela remoção LGPD ainda não é consultado no envio de mensagens e campanhas. Filtre a lista do seu lado antes de enviar.

Permissão: ADMIN.

post/v1/opt-outs

Request

Request body

phonestring required

Telefone E.164 com +.

reasonstring

Motivo. Cortado em 80 caracteres.

Example request

{
  "phone": "+5511999999999"
}

Response

Opt-out registrado

phonestring required
channelstring required
reasonstring nullable
createdAtstring nullable

Example response

{
  "phone": "+5511999999999",
  "channel": "WHATSAPP",
  "reason": "pediu por email",
  "createdAt": "2026-09-15T14:30:00Z"
}

Changes