Skip to main content
POST

Autorizaciones

Authorization
string
header
requerido

Clave API sin autorización de encabezado. Ejemplo: Authorization: Bearer sk_live_xxxxx

Encabezados

Idempotency-Key
string

Clave única para evitar envíos duplicados. Alternativa: x-idempotencia-clave.

x-idempotency-key
string

Clave única para idempotencia (alternativa a Idempotency-Key).

Cuerpo

application/json

Al menos uno de texto o html es obligatorio.

from
string
requerido

Dirección del remitente (por ejemplo, noreply@tudominio.com). El dominio debe estar verificado en el espacio de trabajo.

Minimum string length: 1
to
string[]
requerido

Lista de direcciones de correo electrónico de los destinatarios. Un correo electrónico por dirección.

Required array length: 1 - 100 elements
Minimum string length: 1
type
enum<string>
requerido

Tipo de envío: email (contenido en payload) o template (plantilla del workspace en payload.templateId).

Opciones disponibles:
email,
template
payload
object
requerido

Contenido según type. email: subject (obligatorio) y text y/o html. template: templateId (obligatorio) y variables opcionales.

fromName
string

Nombre mostrado del remitente (opcional).

schedule
object
options
object
metadata
object

Metadatos almacenados en Email.metadata (cadena → pares de cadenas). Respete los límites de carga útil.

listUnsubscribe
boolean
predeterminado:true

RFC 8058: inyecta encabezados List-Unsubscribe y List-Unsubscribe-Post cuando el destinatario se asigna a un contacto del espacio de trabajo. Configure false para correo electrónico transaccional.

listUnsubscribeTopicId
string

Opcional. ID del tema de comunicación para cancelar la suscripción con un solo clic en el ámbito del tema.

Respuesta

Correo electrónico(s) aceptado(s). En cola para envío inmediato o programado.

success
boolean
requerido
Ejemplo:

true

data
object
requerido