Enviar un correo con un documento adjunto
Función sendEmail: destinatarios, asunto, cuerpo y adjuntos (documento, archivo subido o base64) con el correo del programa.
En esta página5 secciones
Antes de empezar
- Una clave con permiso POST sobre
sendEmail. Habilitar la API y gestionar sus claves de acceso - El correo saliente configurado en el programa (Ajustes › Email). Si no lo está, la petición falla.
Enviar el correo
POST/api/3/sendEmail
A diferencia del resto de la API, el cuerpo va en JSON. El correo sale con la cuenta configurada en el programa y queda registrado en su historial de envíos.
Parámetros
-
tostring | string[] Obligatorio - Uno o varios destinatarios.
-
subjectstring Obligatorio - Asunto.
-
bodystring Obligatorio - Texto del mensaje.
-
cc · bccstring | string[] Opcional - Copia y copia oculta.
-
replyTostring Opcional - Dirección de respuesta.
-
attachmentsarray Opcional - Cada adjunto es un objeto con
type:document(modelClassNameymodelCode; solo facturas, albaranes, pedidos y presupuestos de cliente o proveedor),attachedFile(idfilede un archivo subido) obase64(filenameycontent).
curl -s -X POST "$BEPLY_URL/api/3/sendEmail" \
-H "X-Auth-Token: $BEPLY_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"to": "admin@talleresbrisa.example",
"subject": "Tu factura de enero",
"body": "Hola, te enviamos la factura del mes. Gracias.",
"attachments": [
{ "type": "document", "modelClassName": "FacturaCliente", "modelCode": "123" }
]
}'const res = await fetch(`${process.env.BEPLY_URL}/api/3/sendEmail`, {
method: 'POST',
headers: { 'X-Auth-Token': process.env.BEPLY_TOKEN, 'Content-Type': 'application/json' },
body: JSON.stringify({
to: 'admin@talleresbrisa.example',
subject: 'Tu factura de enero',
body: 'Hola, te enviamos la factura del mes. Gracias.',
attachments: [{ type: 'document', modelClassName: 'FacturaCliente', modelCode: '123' }],
}),
})
console.log(await res.json())Respuesta
HTTP 200 con status: success, los destinatarios, los nombres de los adjuntos y la hora de envío.
{
"status": "success",
"message": "email-sent-successfully",
"data": {
"recipients": { … },
"attachments": ["…pdf"],
"sent_at": "2026-01-20 10:15:00"
}
}Errores
Llegan con status, message y code.
-
invalid-json-bodyHTTP 400 - El cuerpo no es JSON válido.
-
to-is-required · subject-is-required · body-is-requiredHTTP 400 - Falta un campo obligatorio.
-
invalid-email-address: …HTTP 400 - Una dirección no es válida (también
invalid-cc-…einvalid-bcc-…). -
attachment[0]: …HTTP 400 - Adjunto mal formado: tipo, modelo o datos que faltan.
-
method-not-allowedHTTP 405 - Usa
POST. -
EMAIL_NOT_CONFIGUREDHTTP 500 - El programa no tiene correo saliente configurado: un administrador lo configura en Ajustes › Email. No se ha enviado nada.
-
SEND_ERROR · email-send-failedHTTP 500 - El servidor de correo rechazó el envío: revisa la configuración de Ajustes › Email y las direcciones.
Comprueba el resultado
El destinatario recibe el correo con el PDF de la factura. Cada llamada envía un correo nuevo: no repitas una petición cortada sin comprobar antes con el destinatario.