Registrar opt-out

POST 
/contacts/:id/opt-out

Tira o consentimento e põe o telefone e o BSUID do contato na lista de supressão. Dispara contact.opted_out.

Com uma API key restrita a alguns números, um contato sem conversa nesses números responde 404, como um que não existe.

Request

Responses

200

Registro encontrado.

401

Token ausente, malformado, desconhecido ou revogado (authentication), ou conta suspensa (tenant_inactive).

402

Sem direito de uso (payment_required). O corpo traz o motivo em reason e a saída em action: o que fazer (kind) e a página do painel onde se faz (url).

404

Recurso inexistente (not_found).

422

Payload reprovado na validação (invalid_request, com o detalhamento em issues) ou recusado pela Meta (meta_error, com o corpo original em meta).

429

Limite de requisições excedido (rate_limit).

Response Headers

Retry-After

Segundos a aguardar antes de tentar de novo.

X-RateLimit-Category

Categoria do limite aplicada — send, media ou default.

X-RateLimit-Scope

Qual balde os outros headers descrevem — key (a API key), session (o painel) ou account (o teto da conta).

X-RateLimit-Limit

Teto de requisições da categoria na janela atual.

X-RateLimit-Remaining

Requisições restantes na janela atual.