campaigns

POST `/v1/campaigns/suppressions`

Add an address to the suppression list.

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Onde vai o ID da sua organização

Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.

O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

curl -X POST https://api.zinndigital.com/v1/campaigns/suppressions \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "email": <string>, "reason": <string<unsubscribed, bounced, complained, staff_blocked>> }'

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

`unsubscribed` applies to your own campaigns. `bounced`, `complained` and `staff_blocked` are facts about the ADDRESS and are stored platform-wide whatever scope you send them under — continuing to mail a hard bounce damages delivery for every other customer sending from the same domain. Idempotent on `(scope, address, purpose)`.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`org_id (query)`	`string`	Não	—

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`email`	`string`	Sim	—
`reason`	`string<unsubscribed, bounced, complained, staff_blocked>`	Sim	—
`note`	`string`	Não	—

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`string`	Sim	—
`email`	`string`	Sim	—
`reason`	`string`	Sim	—

Erros que este endpoint pode retornar

401 · 403 · 422