Saltar al contenido principal
Referencia de la API

Supresiones

Direcciones bloqueadas por rebote, queja o decisión manual.

Listar supresiones

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

Respuesta 200

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

Agregar supresión

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

Cuerpo de la solicitud

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

Respuesta 201

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

Agregar en lote

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

Cuerpo de la solicitud

suppressionsarray<object>1+ itensaté 1000 itensobligatorio

Respuesta 200

insertedCountintegermín. 0máx. 9007199254740991obligatorio

Resumen de supresiones

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

Respuesta 200

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

Obtener supresión

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

Parámetros de ruta

idstring≥ 1obligatorio
Identificador único da supressão

Respuesta 200

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

Eliminar supresión

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

Parámetros de ruta

idstring≥ 1obligatorio
Identificador único da supressão

Reactivar destinatario

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

Parámetros de ruta

idstring≥ 1obligatorio
Identificador único da supressão