Referência da API · Emails
Enviar email
Coloca um email na fila. A resposta volta em milissegundos com o id; acompanhe pelo painel, por Obter email ou por webhooks.
POST
https://api.coffeemail.com.br/v1/product/emailsEscopo: sending_access202 AcceptedSDK: emails.send()
Headers
x-idempotency-key- Opcional. A mesma chave em até 24 h devolve o mesmo email em vez de enviar de novo.
x-coffeemail-sandbox- Opcional. Com true, o email passa pela validação e vira evento, mas não sai para o destinatário.
Corpo da requisição
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 Accepted com o id do email, o status inicial (queued ou scheduled) e a hora em que entrou na fila.
202 Accepted
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
Erros
| HTTP | code | Quando acontece |
|---|---|---|
| 400 | VALIDATION_FAILED | Algum campo do corpo ou da consulta é inválido; meta diz qual. |
| 400 | INVALID_RECIPIENT | O destinatário não é um endereço válido. |
| 401 | UNAUTHORIZED | Chave ausente, inválida ou revogada. |
| 409 | DOMAIN_NOT_VERIFIED | O domínio do remetente ainda não passou na verificação de DNS. |
| 422 | INVALID_FROM_DOMAIN | O from usa um domínio que não pertence à organização. |
| 422 | SENDER_NOT_VERIFIED | O remetente avulso ainda não confirmou o email. |
| 429 | PLAN_QUOTA_EXCEEDED | A cota do plano acabou no ciclo; libere excedente ou mude de plano. |
| 429 | RATE_LIMIT_EXCEEDED | Muitas requisições; espere o tempo de retry-after. |
| 500 | TEMPLATE_RENDER_ERROR | O modelo não renderizou com as variáveis enviadas. |