Referencia de API

Enviar correo electrónico

Send transactional mail only from your verified custom domains over HTTPS — password resets, receipts, alerts, and similar event-driven messages. Not for newsletters or marketing bulk. One endpoint, domain-scoped API keys, delivery through AWS SES.

Resumen

Endpointhttps://api.unbox.im/v1/email
MétodoPOST
Content-Typeapplication/json
ÁmbitoUna clave API por dominio personalizado

Genera claves en Cuenta → Dominios → tu dominio → API tras completar la verificación DNS. La clave completa se muestra una sola vez: guárdala de forma segura. Las credenciales SMTP opcionales en el mismo panel de Dominios siguen las mismas reglas de solo transaccional.

Solo correo transaccional

Unbox HTTP API (POST /v1/email) and optional SMTP submission are for transactional mail only — messages tied to an account action, purchase, or operational event. They are not a newsletter or marketing broadcast service.

Usos permitidos

  • Verificación de cuenta, restablecimiento de contraseñas y alertas de seguridad
  • Confirmaciones de pedido, recibos, actualizaciones de envío y avisos de pago
  • Notificaciones activadas por un usuario o evento del sistema específico
  • Mensajes de equipo y espacio de trabajo (invitaciones, asignaciones, alertas internas)

Usos prohibidos

  • Boletines, campañas promocionales o marketing por difusión
  • Contacto en frío o correo a listas compradas, extraídas o sin consentimiento
  • Spam de afiliados, phishing o contenido engañoso
  • Cualquier intento de eludir los límites de destinatarios, tasas o cuotas del plan

Límites de tasa y destinatarios

Para proteger a los destinatarios y la capacidad de entrega, el tráfico saliente de API y SMTP está sujeto a los límites a continuación (además del cupo mensual saliente de tu plan). La aplicación se realiza en el compositor web, la API HTTP y el envío SMTP. El compositor web advierte después de 25 destinatarios por mensaje y bloquea envíos superiores a 50.

LímiteValor
Destinatarios por mensajeHasta 50 en total (Para + Cc + Cco combinados)
Destinatarios únicos por díaHasta 1,000 por espacio de trabajo
Tasa de solicitudes de envíoHasta 10 envíos de API o SMTP por minuto por dominio
Cupo saliente del planLos límites mensuales de envío de tu suscripción siguen vigentes

Estas reglas son parte de nuestra Política de Uso Aceptable. La aplicación automática está activa en el compositor web, la API HTTP y el envío SMTP. Las cuentas que envíen correos de marketing o masivos, o que abusen de la infraestructura de envío, pueden ser limitadas, suspendidas o canceladas.

Monitoreamos las señales de capacidad de entrega. Las tasas de rebote sostenidas superiores al 3 % o las tasas de queja superiores al 0.1 % pueden provocar una pausa temporal de envío o una revisión manual.

Consulta nuestros Términos de servicio, Política de privacidad y Declaración GDPR para obtener todos los detalles de la política.

Autenticación

Envía la clave API de tu dominio en cada solicitud:

Authorization: Bearer ubk_live_xxxxxxxxxxxxxxxxxxxxxxxx

Alternativamente, usa X-Api-Key: ubk_live_…. Las claves se almacenan con hash; revócalas o cámbialas desde el panel de Dominios.

Cuerpo de la solicitud

JSON con nombres de campos en PascalCase (From, To, …). También se aceptan alias en camelCase.

CampoRequeridoDescripción
FromRemitente: tu buzón personal en el dominio de la clave (principal o alias). Las colas compartidas no son remitentes válidos.
ToDestinatario(s): cadena, cadena separada por comas o array
SubjectLínea de asunto
TextBodyUno de TextBody / HtmlBodyCuerpo de texto plano
HtmlBodyUno de TextBody / HtmlBodyCuerpo HTML
CcNoDestinatarios en copia
BccNoDestinatarios en copia oculta
ReplyToNoDirección de respuesta
TagNoEtiqueta de metadatos opcional (se almacena con el envío)

Ejemplo

{
  "From": "you@yourdomain.com",
  "To": "user@example.com",
  "Subject": "Welcome",
  "TextBody": "Thanks for signing up.",
  "HtmlBody": "<p>Thanks for signing up.</p>",
  "ReplyTo": "you@yourdomain.com",
  "Tag": "welcome"
}

Respuesta exitosa

HTTP 200 con JSON:

{
  "ErrorCode": 0,
  "Message": "OK",
  "MessageID": "0100018…-000000-…",
  "SubmittedAt": "2026-06-23T12:00:00.000Z",
  "To": "user@example.com"
}

Respuestas de error

Los errores devuelven 4xx (o 500 para fallos inesperados) con JSON:

{
  "ErrorCode": 300,
  "Message": "TextBody or HtmlBody is required."
}
Código de errorSignificado
0Éxito
10Falta la clave API
11Clave inválida o revocada, o dominio no verificado para envío
300Error de validación (campos faltantes, JSON inválido, etc.)
403Dirección de origen no permitida — debe ser tu buzón personal en el dominio de la clave
406SES rechazó el mensaje

Ejemplos

Reemplaza you@yourdomain.com con tu buzón personal en el dominio y usa tu propia clave API.

curl "https://api.unbox.im/v1/email" \
  -H "Authorization: Bearer ubk_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "From": "you@yourdomain.com",
  "To": "user@example.com",
  "Subject": "Welcome",
  "TextBody": "Thanks for signing up.",
  "HtmlBody": "<p>Thanks for signing up.</p>",
  "ReplyTo": "you@yourdomain.com",
  "Tag": "welcome"
}'

Primeros pasos

  1. Crea una cuenta de Unbox y añade tu dominio personalizado.
  2. Completa todos los pasos de verificación DNS en Dominios.
  3. Ve a Dominios → tu dominio → API y genera una clave de dominio.
  4. Envía tu primer mensaje con los ejemplos anteriores.
Unbox — Documentación de API | Unbox.im