Enviar desde una plantilla

Este es el endpoint en torno al que se construyen la mayoría de las integraciones: toma una de tus plantillas, asigna personas reales a sus roles y envíala para firmar, todo en una sola llamada. En la API no hay paso de borrador.

Crear un sobre a partir de una plantilla y enviarlo

Requiere el scope envelopes:send. La creación y el envío ocurren juntos: si el envío falla por cualquier motivo, el sobre se elimina y se devuelve un error, de modo que nunca queda un borrador a medio crear. Cada envío correcto consume una de las solicitudes de firma por API de tu plan.

Cuerpo

Cada destinatario asigna una persona real a un rol de la plantilla:

Ejemplo de petición

curl -X POST https://api2.bunnydoc.com/v1/envelopes/from-template \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "template_id": "018f2c3d-4e5f-7a8b-9c0d-1e2f3a4b5c6d",
    "title": "Mutual NDA — Acme Corp",
    "sender_email": "sales@yourco.com",
    "email_subject": "Please sign: Mutual NDA",
    "email_message": "Hi Jane — please review and sign our mutual NDA. Thanks!",
    "recipients": [
      { "role": "Client", "name": "Jane Doe", "email": "jane@acme.com" }
    ]
  }'

POST /v1/envelopes/from-template HTTP/1.1
Host: api2.bunnydoc.com
Authorization: Bearer <access_token>
Content-Type: application/json

{
  "template_id": "018f2c3d-4e5f-7a8b-9c0d-1e2f3a4b5c6d",
  "title": "Mutual NDA — Acme Corp",
  "sender_email": "sales@yourco.com",
  "email_subject": "Please sign: Mutual NDA",
  "email_message": "Hi Jane — please review and sign our mutual NDA. Thanks!",
  "recipients": [
    { "role": "Client", "name": "Jane Doe", "email": "jane@acme.com" }
  ]
}

Respuesta

{
  "envelope_id": "018f9a0b-1c2d-7e3f-8a4b-5c6d7e8f9a0b",
  "status": "sent",
  "title": "Mutual NDA — Acme Corp",
  "sender": { "email": "sales@yourco.com" },
  "recipients": [
    { "role": "Client", "name": "Jane Doe", "email": "jane@acme.com" }
  ],
  "signing_urls": [
    {
      "recipient_id": "018f9a0b-2c3d-7e4f-8a5b-6c7d8e9f0a1b",
      "name": "Jane Doe",
      "email": "jane@acme.com",
      "recipient_type": "need-to-sign",
      "signing_url": "https://sign.bunnydoc.com/s/eyJhbGciOi…"
    }
  ],
  "created_at": "2026-07-28T10:20:00.000Z"
}

Personalizar el correo de invitación

email_subject y email_message controlan el correo que recibe cada destinatario (y los recordatorios que le siguen: los recordatorios reutilizan el asunto con el prefijo Reminder:). Si los omites, se usan los valores de la plantilla.

Placeholders

Ambos campos admiten placeholders que se rellenan por destinatario en el momento del envío. Así una sola llamada puede producir un correo personalizado para cada firmante.

{
  "template_id": "018f2c3d-4e5f-7a8b-9c0d-1e2f3a4b5c6d",
  "email_subject": "{{recipient_first_name}}, firma {{envelope_title}}",
  "email_message": "<p>Hola {{recipient_first_name}}:</p><p>Revisa y firma. Caduca el {{expiry_date}}.</p><p>Gracias,<br/>{{sender_name}}</p>",
  "recipients": [
    { "role": "Client", "name": "Jane Doe", "email": "jane@acme.com" },
    { "role": "Witness", "name": "Sam Ortiz", "email": "sam@acme.com" }
  ]
}

Deliberadamente no hay placeholder para el enlace de firma ni para el código de acceso. El correo ya lleva el botón de firma, y un código de acceso es un segundo factor que debe llegar al destinatario por otra vía. Usa GET /v1/envelopes/{id}/signing-links si tu propio sistema necesita la URL.

Formato en email_message

Envía texto plano (se conservan los saltos de línea) o un subconjunto pequeño y seguro de HTML:

Todo lo demás se elimina a la entrada, incluidos style, class, id, imágenes, tablas y encabezados. El valor guardado es el ya depurado, así que lo que puedes guardar es exactamente lo que recibe el destinatario.

El límite de 10 000 caracteres se cuenta después de depurar, así que algo de marcado suelto no te hará superarlo.

Errores

Obtener los enlaces de firma de un sobre enviado

Los enlaces de firma permiten que el sistema del remitente entregue a cada destinatario un enlace directo en lugar de esperar al correo. Están disponibles en cualquier momento tras el envío y también los devuelve la llamada de envío anterior.

Ejemplo de petición

curl https://api2.bunnydoc.com/v1/envelopes/018f9a0b-1c2d-7e3f-8a4b-5c6d7e8f9a0b/signing-links \
  -H "Authorization: Bearer <access_token>"

GET /v1/envelopes/018f9a0b-1c2d-7e3f-8a4b-5c6d7e8f9a0b/signing-links HTTP/1.1
Host: api2.bunnydoc.com
Authorization: Bearer <access_token>

Respuesta

{
  "signing_urls": [
    {
      "recipient_id": "018f9a0b-2c3d-7e4f-8a5b-6c7d8e9f0a1b",
      "name": "Jane Doe",
      "email": "jane@acme.com",
      "recipient_type": "need-to-sign",
      "signing_url": "https://sign.bunnydoc.com/s/eyJhbGciOi…"
    }
  ]
}

signing_url es null para los destinatarios que no firman (por ejemplo, uno que "recibe una copia").

Errores