Guías

Etiqueta Blanca Cada Correo Electrónico: Cómo Funcionan las Plantillas de Correo Electrónico Personalizadas de Firma.dev

Texto alternativo: "Interfaz de tema oscuro que muestra un panel de notificaciones personalizable. El texto dice 'Personaliza todo', con 'todo' rodeado en morado, lo que transmite personalización."

Cuando integras firmas electrónicas en tu producto, tus clientes no deberían saber qué plataforma lo está gestionando. La experiencia de firma debe sentirse como la tuya, incluyendo cada correo automatizado que se envía durante el proceso. Firma.dev ahora te permite personalizar cada correo de notificación que la plataforma envía en tu nombre, con control total sobre las líneas de asunto, cuerpos HTML y ajustes por espacio de trabajo.

Tus Clientes Ven Tu Marca, No La Nuestra

Cada flujo de trabajo de firma desencadena una serie de correos electrónicos automatizados: la invitación inicial, la notificación al siguiente firmante en un flujo secuencial, avisos de expiración, mensajes de cancelación y notificaciones de rechazo. Antes de las plantillas de correo personalizables, todos esos se enviaban con la copia y formato predeterminados de Firma.dev.

Ahora controlas los cinco:

Tipo de Correo

Cuándo Se Envía

signing_invite

Cuando se envía por primera vez una solicitud de firma a un destinatario

next_signer

Cuando es el turno del siguiente firmante en una orden de firma

signing_expired

Cuando expira una solicitud de firma

signing_cancelled

Cuando un remitente cancela una solicitud de firma

signing_declined

Cuando un firmante se niega a firmar

Tanto la línea de asunto (texto plano, máximo 500 caracteres) como el cuerpo (HTML, máximo 50,000 caracteres) son completamente personalizables para cada tipo. Puedes igualar exactamente el tono, diseño, colores y copia de tu marca.

Marcadores Dinámicos

Las plantillas admiten una sintaxis de {{placeholder}} para inyectar valores en vivo en el momento del envío. La lista completa de marcadores disponibles se puede descubrir a través de GET /email-templates/placeholders, e incluye los que más usarás:

  • {{signing_link}} — el enlace único del firmante para acceder al documento

  • {{signer_name}} — el nombre del destinatario

  • {{document_name}} — el nombre de la solicitud de firma

Un ejemplo práctico de un cuerpo de signing_invite:

<p>Hi {{signer_name}},</p>
<p>
  {{sender_name}} has sent you a document to review and sign.
  Please use the link below to access it.
</p>
<p>
  <a href="{{signing_link}}" style="background:#1a1a1a;color:#fff;padding:12px 24px;border-radius:4px;text-decoration:none;">
    Review and Sign
  </a>
</p>
<p>This link expires in {{expiration_hours}} hours.</p>
<p>The {{company_name}} Team</p>
<p>Hi {{signer_name}},</p>
<p>
  {{sender_name}} has sent you a document to review and sign.
  Please use the link below to access it.
</p>
<p>
  <a href="{{signing_link}}" style="background:#1a1a1a;color:#fff;padding:12px 24px;border-radius:4px;text-decoration:none;">
    Review and Sign
  </a>
</p>
<p>This link expires in {{expiration_hours}} hours.</p>
<p>The {{company_name}} Team</p>
<p>Hi {{signer_name}},</p>
<p>
  {{sender_name}} has sent you a document to review and sign.
  Please use the link below to access it.
</p>
<p>
  <a href="{{signing_link}}" style="background:#1a1a1a;color:#fff;padding:12px 24px;border-radius:4px;text-decoration:none;">
    Review and Sign
  </a>
</p>
<p>This link expires in {{expiration_hours}} hours.</p>
<p>The {{company_name}} Team</p>

Una nota para desarrolladores: si tu cuerpo de plantilla no incluye {{signing_link}}, la API devuelve una advertencia al guardar. La guarda aún tiene éxito, pero la advertencia está ahí para detectar el error antes de que un firmante reciba un correo sin manera de acceder a su documento.

Plantillas a Nivel de Compañía y de Espacio de Trabajo

El sistema de plantillas utiliza una jerarquía de tres niveles: la plantilla del espacio de trabajo tiene prioridad, luego la plantilla de la compañía, y después el predeterminado integrado de Firma.dev. Esto te brinda dos patrones de integración natural.

Estableciendo un Predeterminado a Nivel de Compañía

Configura tu plantilla de marca una vez a nivel de compañía y se aplica a cada espacio de trabajo que no tenga su propio ajuste. El patrón de endpoint del registro de cambios de la API:

PUT /company/email-templates/{email_type}
{
  "subject": "Please sign: {{document_name}}",
  "body": "<p>Hi {{signer_name}},</p><p>Please review and sign using this link: {{signing_link}}</p>"
}
PUT /company/email-templates/{email_type}
{
  "subject": "Please sign: {{document_name}}",
  "body": "<p>Hi {{signer_name}},</p><p>Please review and sign using this link: {{signing_link}}</p>"
}
PUT /company/email-templates/{email_type}
{
  "subject": "Please sign: {{document_name}}",
  "body": "<p>Hi {{signer_name}},</p><p>Please review and sign using this link: {{signing_link}}</p>"
}

Anular por Espacio de Trabajo

Para socios que usan el modelo de espacio de trabajo del cliente de Firma.dev, cada espacio de trabajo puede tener sus propias plantillas de correo electrónico. Este ejemplo de curl es del guía de etiqueta blanca:

curl -X PUT https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/email-templates/signing_invite \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "Action required: Please sign {{document_name}}",
    "body": "<p>Hi {{signer_name}},</p><p>{{sender_name}} has requested your signature on {{document_name}}.</p><p><a href=\"{{signing_link}}\">Sign now</a></p><p>— The {{workspace_name}} Team</p>"
  }'
curl -X PUT https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/email-templates/signing_invite \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "Action required: Please sign {{document_name}}",
    "body": "<p>Hi {{signer_name}},</p><p>{{sender_name}} has requested your signature on {{document_name}}.</p><p><a href=\"{{signing_link}}\">Sign now</a></p><p>— The {{workspace_name}} Team</p>"
  }'
curl -X PUT https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/email-templates/signing_invite \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "Action required: Please sign {{document_name}}",
    "body": "<p>Hi {{signer_name}},</p><p>{{sender_name}} has requested your signature on {{document_name}}.</p><p><a href=\"{{signing_link}}\">Sign now</a></p><p>— The {{workspace_name}} Team</p>"
  }'

Un espacio de trabajo que sirve a clientes en Alemania podría usar plantillas en alemán con la marca específica de ese cliente, mientras que otro espacio de trabajo usa los predeterminados de toda tu compañía.

Eliminar una plantilla de espacio de trabajo hace que ese espacio de trabajo vuelva al predeterminado a nivel de compañía. Eliminar la plantilla de la compañía hace que se vuelva al predeterminado integrado de Firma.dev. La cadena de respaldo siempre tiene algo donde caer.

Referencia Completa de la API

Endpoint

Descripción

GET /company/email-templates

Listar todas las plantillas a nivel de compañía

PUT /company/email-templates/{email_type}

Crear o actualizar una plantilla de compañía

DELETE /company/email-templates/{email_type}

Eliminar una plantilla de compañía

GET /workspace/{id}/email-templates

Listar todas las plantillas de espacio de trabajo

GET /workspace/{id}/email-templates/{email_type}

Obtener una plantilla de espacio de trabajo específica

PUT /workspace/{id}/email-templates/{email_type}

Crear o actualizar una plantilla de espacio de trabajo

DELETE /workspace/{id}/email-templates/{email_type}

Eliminar una plantilla de espacio de trabajo

GET /email-templates/defaults/{language}

Obtener predeterminados integrados para un idioma

GET /email-templates/placeholders

Obtener todos los marcadores disponibles

El endpoint GET /email-templates/defaults/{language} es particularmente útil como punto de partida: obtén la plantilla integrada para tu idioma objetivo, personalízala y guárdala de nuevo. No es necesario escribir correos desde cero.

Empezando

Las plantillas de correo personalizadas están disponibles desde la API v1.8.0 en adelante sin cambios que rompan la compatibilidad. Si ya estás integrado, puedes comenzar a personalizar correos hoy mismo sin tocar ninguna lógica de solicitud de firma existente.

Comienza con Firma.dev gratis, no se requiere tarjeta de crédito. Todas las solicitudes de firma son 0.029 por sobre, sin mínimos mensuales.

  1. Encabezado

Imagen de fondo

¿Listo para añadir firmas electrónicas a tu aplicación?

Comienza gratis. No se requiere tarjeta de crédito. Paga solo 0,029 € por sobre cuando estés listo para ponerlo en marcha.

Imagen de fondo

¿Listo para añadir firmas electrónicas a tu aplicación?

Comienza gratis. No se requiere tarjeta de crédito. Paga solo 0,029 € por sobre cuando estés listo para ponerlo en marcha.

Imagen de fondo

¿Listo para añadir firmas electrónicas a tu aplicación?

Comienza gratis. No se requiere tarjeta de crédito. Paga solo 0,029 € por sobre cuando estés listo para ponerlo en marcha.