Saltar al contenido principal
Referencia de la API

Emails

Enviar, listar, seguir, cancelar y 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

Respuesta 200

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

Enviar email

POSThttps://api.coffeemail.com.br/v1/product/emails202
Ver la página completa de este endpoint →

Cuerpo de la solicitud

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

Respuesta 202

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

Enviar en lote

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

Resumen de envíos

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)

Respuesta 200

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

Listar tags

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

Respuesta 200

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

Obtener email

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

Parámetros de ruta

idstringobligatorio
ID único do e-mail

Respuesta 200

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

Eventos del email

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

Parámetros de ruta

idstringobligatorio
ID único do e-mail

Respuesta 200

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

Cancelar email programado

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

Parámetros de ruta

idstringobligatorio
ID único do e-mail

Reenviar email

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

Parámetros de ruta

idstringobligatorio
ID único do e-mail

Respuesta 202

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