Enviar correos electrónicos

Registra una o más solicitudes de envío de correo electrónico.

Contenido

Debe proporcionarse exactamente uno entre templateId y html.

  • Con templateId, el asunto proviene de la plantilla almacenada y cualquier subject enviado se ignora. Consulte las plantillas disponibles en GET /email/v1/templates.
  • Con html, subject es obligatorio.

Tanto el asunto como el cuerpo admiten variables con la sintaxis {{variable}}, que se sustituyen con los valores de fields de cada destinatario.

Remitente

from es obligatorio y debe pertenecer a un dominio remitente verificado para la cuenta.

Adjuntos

Los archivos se envían en base64 dentro del array attachments, en la misma solicitud.

  • Para que todos los destinatarios reciban los mismos archivos, declare attachments en la raíz.
  • Para enviar archivos distintos a cada destinatario, declare attachments dentro de cada elemento de payload.

No mezcle los dos modos. Se admiten hasta 10 archivos que sumen 8 MB, y el cuerpo completo de la solicitud no puede superar 20 MB.

Los campos attachmentId y attachmentName, tanto en la raíz como dentro del destinatario, pertenecen al flujo heredado que exige cargar el archivo antes con POST /email/v1/attachments. Utilice attachments en su lugar.

Respuesta

El servicio retorna 202 incluso cuando la solicitud o algunos destinatarios fallan validación. Revise siempre overallStatus, errors y el estado individual de cada elemento de recipients.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Dirección remitente obligatoria. Debe pertenecer a un dominio verificado para la cuenta.

string

Nombre visible del remitente.

string

Asunto del correo. Obligatorio cuando se utiliza html. Con templateId, el asunto de la plantilla prevalece y este valor se ignora. Admite variables {{variable}}.

string

Identificador de una plantilla almacenada. Es excluyente con html. Obtenga los identificadores disponibles en GET /email/v1/templates.

string

Contenido HTML directo. Es excluyente con templateId y requiere subject. Admite variables {{variable}}.

attachments
array of objects
length ≤ 10

Archivos que recibirán todos los destinatarios. Hasta 10 archivos que sumen 8 MB. Es excluyente con los adjuntos por destinatario.

attachments
string
deprecated

Heredado. Identificador de un archivo cargado previamente mediante POST /email/v1/attachments, aplicado a todos los destinatarios. Use attachments en su lugar. Requiere attachmentName.

string
deprecated

Heredado. Nombre visible del archivo referenciado por attachmentId.

payload
array of objects
required
length between 1 and 50

Destinatarios, procesados individualmente. Máximo 50 por solicitud.

payload*
string
required

Dirección de correo electrónico del destinatario.

fields
object

Valores que sustituyen las variables {{variable}} del asunto, la plantilla o el HTML.

attachments
array of objects
length ≤ 10

Archivos exclusivos de este destinatario. Hasta 10 archivos que sumen 8 MB. Es excluyente con los adjuntos declarados en la raíz.

attachments
string
deprecated

Heredado. Identificador de un archivo cargado previamente mediante POST /email/v1/attachments. Use attachments en su lugar. Requiere attachmentName.

string
deprecated

Heredado. Nombre visible del archivo referenciado por attachmentId.

Responses

401

API key ausente o no válida.

403

La API key es válida pero no tiene permiso para enviar correo.

413

El cuerpo de la solicitud supera los 20 MB. Envíe menos destinatarios o menos adjuntos por llamada.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json