Skip to main content
API reference

Emails

Send, list, track, cancel and resend emails.

List emails

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

Query parameters

status"queued" | "processing" | "sent" | "delivered" | "bounced" | "complained" | "failed" | "skipped" | "scheduled" | "cancelled"
Filtra e-mails por status de envio
recipientstring≥ 1≤ 254
Busca parcial por destinatário em to/cc/bcc
fromEmailstring≥ 1≤ 254
Filtra e-mails por endereço do remetente
subjectContainsstring≥ 1≤ 200
Busca parcial no assunto do e-mail
apiKeyIdstring (uuid)
Filtra e-mails enviados por uma API key específica
tagstring≥ 1≤ 255
Filtra e-mails que possuem esta tag
fromstring (date-time)
Data/hora inicial do período de busca (inclusivo)
tostring (date-time)
Data/hora final do período de busca (inclusivo)
afterstring≥ 1≤ 512
Cursor de paginação: use o nextCursor da página anterior (uma data ISO legada também é aceita)
pageintegermín. 0máx. 100000
Página numerada (começa em 1). Ignorada quando `after` é enviado
limitintegermín. 0máx. 100
Quantidade máxima de e-mails retornados

Response 200

emailsarray<object>required
Lista de e-mails retornados
nextCursorstringrequired
Cursor para buscar a próxima página
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

Send email

POSThttps://api.coffeemail.com.br/v1/product/emails202
See the full page for this endpoint →

Request body

fromobjectrequired
Remetente do e-mail
from.emailstring (email)required
Endereço de e-mail
from.namestring≤ 200
Nome de exibição do contato
toarray<object>1+ itensaté 50 itensrequired
Lista de destinatários do e-mail
ccarray<object>até 50 itens
Lista de destinatários em cópia
bccarray<object>até 50 itens
Lista de destinatários em cópia oculta
replyToobject
Endereço para onde respostas devem ser enviadas
replyTo.emailstring (email)required
Endereço de e-mail
replyTo.namestring≤ 200
Nome de exibição do contato
subjectstring≥ 1≤ 998
Assunto do e-mail
htmlstring≤ 102400
Corpo do e-mail em HTML
textstring≤ 102400
Corpo do e-mail em texto puro
headersobject
Cabeçalhos SMTP customizados a incluir no envio
attachmentsarray<object>até 10 itens
Arquivos anexados ao e-mail
templateIdstring≥ 1≤ 100
Id ou alias do template usado para montar o e-mail
variablesobject
Variáveis para preencher o template
emailType"transactional" | "broadcast"
Categoria do envio para fins de rastreio e supressão
suppressionCategorystring≥ 1≤ 100
Categoria usada para checar a lista de supressão
tagsarray<object>até 10 itens
Tags para categorizar e filtrar o e-mail depois
scheduledAtstring (date-time)
Data/hora futura para o envio agendado do e-mail
metadataobject
Metadados customizados para rastreio ou webhook

Response 202

idstring (uuid)required
ID único do e-mail criado
status"queued" | "scheduled"required
Status inicial do e-mail após o envio
queuedAtstring (date-time)required
Data/hora em que o e-mail entrou na fila

Send a batch

POSThttps://api.coffeemail.com.br/v1/product/emails/batch202

Sending summary

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

Query parameters

fromstring (date-time)
Data/hora inicial do período de busca (inclusivo)
tostring (date-time)
Data/hora final do período de busca (inclusivo)
recipientstring≥ 1≤ 254
Busca parcial por destinatário em to/cc/bcc
fromEmailstring≥ 1≤ 254
Filtra e-mails por endereço do remetente
subjectContainsstring≥ 1≤ 200
Busca parcial no assunto do e-mail
apiKeyIdstring (uuid)
Filtra e-mails enviados por uma API key específica
tagstring≥ 1≤ 255
Filtra e-mails que possuem esta tag
sincestring (date-time)
Instante de referência para contar os e-mails novos (newSince)

Response 200

fromstring (date-time)required
Início do período considerado
tostring (date-time)required
Fim do período considerado
totalintegermín. 0máx. 9007199254740991required
Total de e-mails no período e filtros
byStatusobjectrequired
Quantidade de e-mails por status; todo status aparece, com zero quando vazio
openedintegermín. 0máx. 9007199254740991required
E-mails abertos ao menos uma vez
clickedintegermín. 0máx. 9007199254740991required
E-mails com ao menos um clique
newSinceintegermín. 0máx. 9007199254740991required
E-mails criados depois de `since`; null quando `since` não é enviado

List tags

GEThttps://api.coffeemail.com.br/v1/product/emails/tags200

Response 200

tagsarray<object>required
Tags distintas usadas em e-mails enviados

Get email

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

Path parameters

idstringrequired
ID único do e-mail

Response 200

idstring (uuid)required
ID único do e-mail
fromstringrequired
Endereço do remetente
toarray<string>required
Lista de destinatários
ccarray<string>required
Lista de destinatários em cópia
bccarray<string>required
Lista de destinatários em cópia oculta
subjectstringrequired
Assunto do e-mail
status"queued" | "processing" | "sent" | "delivered" | "bounced" | "complained" | "failed" | "skipped" | "scheduled" | "cancelled"required
Status atual do envio
attemptsintegermín. 0máx. 9007199254740991required
Número de tentativas de envio realizadas
lastErrorstringrequired
Última mensagem de erro registrada no envio
messageIdstringrequired
ID da mensagem retornado pelo provedor de envio
createdAtstring (date-time)required
Data/hora de criação do registro
scheduledAtstring (date-time)required
Data/hora agendada para o envio
sentAtstring (date-time)required
Data/hora em que o e-mail foi enviado
deliveredAtstring (date-time)required
Data/hora em que a entrega foi confirmada
bouncedAtstring (date-time)required
Data/hora do bounce, se houve
failedAtstring (date-time)required
Data/hora da falha, se houve
complainedAtstring (date-time)required
Data/hora da reclamação de spam, se houve
suppressedAtstring (date-time)required
Data/hora em que o e-mail foi suprimido, se houve
openedAtstring (date-time)required
Data/hora da primeira abertura
firstClickedAtstring (date-time)required
Data/hora do primeiro clique em um link
openCountintegermín. 0máx. 9007199254740991required
Quantidade de vezes que o e-mail foi aberto
clickCountintegermín. 0máx. 9007199254740991required
Quantidade de cliques em links do e-mail
proxyOpenCountintegermín. 0máx. 9007199254740991required
Aberturas registradas por proxy de privacidade (Gmail Image Proxy, Apple MPP). Nao contam como abertura humana
tagsarray<object>required
Tags associadas ao e-mail
htmlstringrequired
Corpo do e-mail em HTML
textstringrequired
Corpo do e-mail em texto puro
apiKeyobject
API key usada para enviar o e-mail
apiKey.idstringrequired
ID da API key usada no envio
apiKey.namestringrequired
Nome da API key usada no envio
replyTostringrequired
Endereço de resposta (Reply-To)
emailTypestringrequired
Tipo do envio: transactional ou broadcast
metadataobjectrequired
Metadados enviados junto com o e-mail
templateobjectrequired
Template usado no envio, se houver
template.idstring (uuid)required
ID do template usado no envio
template.namestringrequired
Nome atual do template
template.versionintegermín. -9007199254740991máx. 9007199254740991required
Versão do template no momento do envio
sizeBytesintegermín. 0máx. 9007199254740991required
Tamanho estimado da mensagem em bytes
deliveryobjectrequired
Detalhes técnicos da entrega
delivery.relayHoststringrequired
Relay SMTP que aceitou a mensagem
delivery.sendingIpstringrequired
IP público de saída do relay, quando configurado
delivery.relayResponsestringrequired
Resposta SMTP do relay ao aceitar a mensagem
delivery.attemptedAtstring (date-time)required
Data/hora da tentativa no relay
delivery.reportingMtastringrequired
MTA que reportou a entrega final (DSN/SES)
delivery.remoteMtaIpstringrequired
IP do MTA de destino
delivery.smtpResponsestringrequired
Resposta SMTP do servidor de destino
delivery.reportedAtstring (date-time)required
Data/hora do relatório de entrega

Email events

GEThttps://api.coffeemail.com.br/v1/product/emails/{id}/events200

Path parameters

idstringrequired
ID único do e-mail

Response 200

idstring (uuid)required
ID único do e-mail
eventsarray<object>required
Linha do tempo de eventos do e-mail

Cancel scheduled email

POSThttps://api.coffeemail.com.br/v1/product/emails/{id}/cancel204

Path parameters

idstringrequired
ID único do e-mail

Resend email

POSThttps://api.coffeemail.com.br/v1/product/emails/{id}/resend202

Path parameters

idstringrequired
ID único do e-mail

Response 202

idstring (uuid)required
ID único do e-mail criado
status"queued" | "scheduled"required
Status inicial do e-mail após o envio
queuedAtstring (date-time)required
Data/hora em que o e-mail entrou na fila