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

Emails

Enviar, listar, acompanhar, cancelar e reenviar emails.

Listar emails

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

Parâmetros de consulta

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

Resposta 200

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

Enviar email

POSThttps://api.coffeemail.com.br/v1/product/emails202
Ver a página completa deste endpoint →

Corpo da requisição

fromobjectobrigatório
Remetente do e-mail
from.emailstring (email)obrigatório
Endereço de e-mail
from.namestring≤ 200
Nome de exibição do contato
toarray<object>1+ itensaté 50 itensobrigatório
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)obrigatório
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

Resposta 202

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

Enviar em lote

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

Resumo dos envios

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

Parâmetros de consulta

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)

Resposta 200

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

Listar tags

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

Resposta 200

tagsarray<object>obrigatório
Tags distintas usadas em e-mails enviados

Obter email

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

Parâmetros do caminho

idstringobrigatório
ID único do e-mail

Resposta 200

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

Eventos do email

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

Parâmetros do caminho

idstringobrigatório
ID único do e-mail

Resposta 200

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

Cancelar email agendado

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

Parâmetros do caminho

idstringobrigatório
ID único do e-mail

Reenviar email

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

Parâmetros do caminho

idstringobrigatório
ID único do e-mail

Resposta 202

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