Skip to main content
A API Key é o cartão de acesso: cada escopo abre uma porta. Para supressões, existem só duas — leitura e escrita.

​
Em poucas palavras

  • suppressions:read — listar e consultar entradas.
  • suppressions:write — adicionar, importar e remover.
  • Escrita não exige leitura na mesma chave, mas integrações de administração costumam usar as duas.
Guia geral: Chaves de API. Primeiro uso: Quick Start.

​
Como enviar a chave

Alternativa: x-api-key: sk_live_xxxxx.
Escopos vazios na criação = acesso ADMIN (tudo). Em produção, restrinja sempre.

​
Combinações prontas

Só consultar

suppressions:read

Só alterar

suppressions:write

Administração completa

suppressions:read, suppressions:write

CRM + supressões

contacts:read, suppressions:read, suppressions:write

​
Escopos disponíveis

Listar supressões (GET /v1/suppressions) e consultar por ID (GET /v1/suppressions/{id}).
Adicionar (POST /v1/suppressions), lote (POST /v1/suppressions/batch/add), remover por ID, por identidade e lote de remoção.

​
Erros comuns

Catálogo completo: Respostas de erro.

​
Próximos passos