Referencia de la API · Emails
Enviar email
Pone un email en la cola. La respuesta vuelve en milisegundos con el id; síguelo en el panel, con Obtener email o por webhooks.
POST
https://api.coffeemail.com.br/v1/product/emailsAlcance: sending_access202 AcceptedSDK: emails.send()
Headers
x-idempotency-key- Opcional. La misma clave en hasta 24 h devuelve el mismo email en vez de enviar de nuevo.
x-coffeemail-sandbox- Opcional. Con true, el email pasa por la validación y genera eventos, pero no sale al destinatario.
Cuerpo de la solicitud
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 Accepted con el id del email, el estado inicial (queued o scheduled) y la hora en que entró en la cola.
202 Accepted
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
Errores
| HTTP | code | Cuándo ocurre |
|---|---|---|
| 400 | VALIDATION_FAILED | Algún campo del cuerpo o de la consulta es inválido; meta dice cuál. |
| 400 | INVALID_RECIPIENT | El destinatario no es una dirección válida. |
| 401 | UNAUTHORIZED | Clave ausente, inválida o revocada. |
| 409 | DOMAIN_NOT_VERIFIED | El dominio del remitente aún no pasó la verificación de DNS. |
| 422 | INVALID_FROM_DOMAIN | El from usa un dominio que no pertenece a la organización. |
| 422 | SENDER_NOT_VERIFIED | El remitente suelto aún no confirmó el email. |
| 429 | PLAN_QUOTA_EXCEEDED | La cuota del plan se acabó en el ciclo; habilita excedente o cambia de plan. |
| 429 | RATE_LIMIT_EXCEEDED | Demasiadas solicitudes; espera el tiempo de retry-after. |
| 500 | TEMPLATE_RENDER_ERROR | La plantilla no se renderizó con las variables enviadas. |