Skip to main content
API reference

Suppressions

Addresses blocked by bounce, complaint or manual decision.

List suppressions

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

Query parameters

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

Response 200

suppressionsarray<object>required
Lista de supressões encontradas
nextCursorstringrequired
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. 9007199254740991required
Total de itens que batem com os filtros
pagination.pageintegermín. 0máx. 9007199254740991required
Página atual (começa em 1)
pagination.limitintegermín. 0máx. 9007199254740991required
Itens por página
pagination.totalPagesintegermín. 0máx. 9007199254740991required
Quantidade de páginas
pagination.totalIsEstimatebooleanrequired
true quando o total passa de 10000 e vem de estimativa

Add suppression

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

Request body

emailstring (email)≤ 254required
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

Response 201

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

Add in bulk

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

Request body

suppressionsarray<object>1+ itensaté 1000 itensrequired

Response 200

insertedCountintegermín. 0máx. 9007199254740991required

Suppressions summary

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

Response 200

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

Get suppression

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

Path parameters

idstring≥ 1required
Identificador único da supressão

Response 200

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

Remove suppression

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

Path parameters

idstring≥ 1required
Identificador único da supressão

Reactivate recipient

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

Path parameters

idstring≥ 1required
Identificador único da supressão