ZaplinDocs
GuiasReferência da APIMCPChangelogAbrir o app

Registrar descadastro

POST
/v1/contacts/{id}/opt-out

Registra que o contato pediu para não receber mais mensagens: campanhas e automações o deixam de fora.

Escopo: contacts:write

Autorização

bearer contacts:write
headerAutorizaçãoBearer <token>

A chave de API de uma conta de serviço (sk_live_…, 600 requisições por minuto cada) ou um access token OAuth para o recurso /api/v1 (600 requisições por minuto por conexão).

Escopo: contacts:write

Parâmetros de caminho

id*string

O id.

Cabeçalhos

Idempotency-Key?string

Até 200 letras, dígitos, - ou _. A primeira resposta a uma chave é repetida por 24 horas.

Tamanholength <= 200

Corpo da resposta

Feito.

application/json
  1. response
id*string
opted_out*boolean
Exemplo de requisição
curl -X POST 'https://app.zaplin.com.br/api/v1/contacts/string/opt-out' \  -H 'Authorization: Bearer sk_live_...'
Exemplo de resposta
{  "id": "string",  "opted_out": true}