Pular para o conteúdo principal
Referência da API

Supressões

Endereços bloqueados por bounce, reclamação ou decisão manual.

Listar supressões

GEThttps://api.coffeemail.com.br/v1/product/suppressions200

Parâmetros de consulta

status"active" | "expired" | "inactive"
Filtra supressões pela situação atual
reason"manual" | "bounce" | "isp_block" | "mailbox_not_found" | "complaint" | "unsubscribe"
Filtra supressões pelo motivo
source"manual" | "auto"
Filtra supressões pela origem: manual ou automática
category"manual" | "bounce" | "block" | "complaint" | "unsubscribe" | "invalid_email" | "global"
Filtra supressões pela categoria
qstring≥ 1≤ 254
Busca por parte do endereço de email
pageintegermín. 0máx. 100000
Página numerada (começa em 1). Ignorada quando `after` é enviado
afterstring≥ 1≤ 512
Cursor de paginação para continuar a partir do último resultado
limitintegermín. 0máx. 200
Quantidade máxima de supressões retornadas por página

Resposta 200

suppressionsarray<object>obrigatório
Lista de supressões encontradas
nextCursorstringobrigatório
Cursor para buscar a próxima página de resultados
paginationobject
Paginação numerada. Ausente quando a consulta usa cursor (`after`)
pagination.totalintegermín. 0máx. 9007199254740991obrigatório
Total de itens que batem com os filtros
pagination.pageintegermín. 0máx. 9007199254740991obrigatório
Página atual (começa em 1)
pagination.limitintegermín. 0máx. 9007199254740991obrigatório
Itens por página
pagination.totalPagesintegermín. 0máx. 9007199254740991obrigatório
Quantidade de páginas
pagination.totalIsEstimatebooleanobrigatório
true quando o total passa de 10000 e vem de estimativa

Adicionar supressão

POSThttps://api.coffeemail.com.br/v1/product/suppressions201

Corpo da requisição

emailstring (email)≤ 254obrigatório
Endereço de email a ser suprimido
reason"manual" | "bounce" | "complaint"
Motivo da supressão
expiresAtstring (date-time)
Data em que a supressão expira e o email volta a receber envios

Resposta 201

idstring (uuid)obrigatório
Identificador único da supressão
emailstringobrigatório
Endereço de email suprimido
reason"manual" | "bounce" | "isp_block" | "mailbox_not_found" | "complaint" | "unsubscribe"obrigatório
Motivo que originou a supressão
source"manual" | "auto"obrigatório
Origem da supressão: manual ou automática
categorystringobrigatório
Categoria de classificação da supressão
status"active" | "expired" | "inactive"obrigatório
Situação atual da supressão
expiresAtstring (date-time)obrigatório
Data em que a supressão expira e o email volta a receber envios
createdAtstring (date-time)obrigatório
Data de criação da supressão

Adicionar em lote

POSThttps://api.coffeemail.com.br/v1/product/suppressions/bulk200

Corpo da requisição

suppressionsarray<object>1+ itensaté 1000 itensobrigatório

Resposta 200

insertedCountintegermín. 0máx. 9007199254740991obrigatório

Resumo das supressões

GEThttps://api.coffeemail.com.br/v1/product/suppressions/summary200

Resposta 200

totalintegermín. 0máx. 9007199254740991obrigatório
Supressões ativas
bouncesintegermín. 0máx. 9007199254740991obrigatório
Ativas por bounce (inclui caixa inexistente e bloqueio do provedor)
complaintsintegermín. 0máx. 9007199254740991obrigatório
Ativas por reclamação de spam
unsubscribesintegermín. 0máx. 9007199254740991obrigatório
Ativas por descadastro
manualintegermín. 0máx. 9007199254740991obrigatório
Ativas adicionadas manualmente

Obter supressão

GEThttps://api.coffeemail.com.br/v1/product/suppressions/{id}200

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador único da supressão

Resposta 200

idstring (uuid)obrigatório
Identificador único da supressão
emailstringobrigatório
Endereço de email suprimido
reason"manual" | "bounce" | "isp_block" | "mailbox_not_found" | "complaint" | "unsubscribe"obrigatório
Motivo que originou a supressão
source"manual" | "auto"obrigatório
Origem da supressão: manual ou automática
categorystringobrigatório
Categoria de classificação da supressão
status"active" | "expired" | "inactive"obrigatório
Situação atual da supressão
expiresAtstring (date-time)obrigatório
Data em que a supressão expira e o email volta a receber envios
createdAtstring (date-time)obrigatório
Data de criação da supressão

Remover supressão

DELETEhttps://api.coffeemail.com.br/v1/product/suppressions/{id}200

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador único da supressão

Reativar destinatário

POSThttps://api.coffeemail.com.br/v1/product/suppressions/{id}/reactivate200

Parâmetros do caminho

idstring≥ 1obrigatório
Identificador único da supressão