Qué es
La API de correo electrónico envía un correo a uno o más destinatarios. Úsela para notificaciones transaccionales, actualizaciones de cuenta, recibos y mensajes personalizados.Antes de empezar
- Guarde su clave de API de YCloud en
YCLOUD_API_KEY. - Registre y active el dominio del remitente en su cuenta de YCloud.
- Utilice una dirección de remitente del dominio activado.
- Prepare contenido HTML o de texto sin formato que no supere los 150 KB.
Cómo funciona
Envíe el correo electrónico conPOST /emails. La respuesta confirma que YCloud aceptó
el correo electrónico y devuelve su id. La entrega se realiza por separado para cada dirección en
to, cc y bcc.
Suscríbase a email.delivery.updated para recibir estados a nivel de destinatario como
sent, delivered, undelivered y failed.
Solicitud
POST /emails
Campos de la solicitud
Ejemplo de solicitud
Respuesta
Una respuesta exitosa devuelve el objeto de correo electrónico creado. La aceptación no significa que cada destinatario haya recibido el correo electrónico.Ejemplo de respuesta
Campos de respuesta
Personalizar contenido
Coloque las variables entre los caracteres# en el contenido. Proporcione un
objeto de variable para cada dirección en to.
Estado de entrega
Suscríbete aemail.delivery.updated. Cada evento identifica el correo electrónico y el
recipientAddress específico, porque los destinatarios pueden tener diferentes
estados finales.
Los mensajes text/plain no generan eventos de seguimiento de clics o aperturas.
Límites y solución de problemas
- El dominio del remitente debe estar activado antes de enviar.
toadmite un máximo de 100 direcciones.subjectadmite un máximo de 255 caracteres.contentadmite un máximo de 150 KB.- Una respuesta exitosa de la API aún puede ir seguida de un
undeliveredo evento de destinatariofailed. - Utilice el
iddel correo electrónico, la dirección del destinatario y elexternalIdal investigar la entrega.

