Skip to main content
Do cadastro na lista ao primeiro bloqueio em poucos passos. A API Key precisa dos escopos suppressions:read e suppressions:write.

Em poucas palavras

  • Adicione e-mail, telefone, Telegram ou Instagram na lista global de não contatar.
  • Consulte entradas com filtros por tipo, motivo e busca.
  • Remova por ID ou por identidade quando o cliente voltar a aceitar mensagens.
Contexto: Introdução. Escopos: Escopos da API Key.

Antes de começar

Base URL: https://api.notifique.dev.

1. Adicionar na lista

Telefone bloqueia SMS, WhatsApp, RCS e voz de uma vez — como colocar o número no caderno da portaria.
Resposta esperada: 201 (nova entrada) ou 200 (já existia, idempotente). A API normaliza o telefone para E.164 antes de salvar.
A inclusão é idempotente: se a identidade já estiver ativa, a API devolve a entrada existente sem duplicar.

E-mail, Telegram ou Instagram

Detalhes de formatação: Normalização por tipo.

2. Listar e consultar

Listar com filtros opcionais:
Parâmetros úteis: type, reason, origin, channel, search. Consultar uma entrada pelo ID retornado no POST:

3. Remover da lista

Por ID:
Por identidade (sem precisar do ID):
Remover reativa o envio imediatamente. Se o endereço voltar a gerar bounce, complaint ou STOP, pode ser suprimido de novo automaticamente.

4. Importar em lote

Na API, envie até 100 itens por chamada:
Cada item retorna status individual: adicionada, já existente ou inválida. No painel (Audiência → Supressões), importe CSV/XLSX com cabeçalhos type,value,reason — até 1.000 linhas, em lotes de 100. A coluna channel no CSV é contexto de importação no painel; na API v1 o bloqueio segue o type (telefone bloqueia sms/whatsapp/rcs/voice). Para remover em lote: POST /v1/suppressions/batch/remove com ids e/ou identities.

Próximos passos