Guides et tutoriels

Personnalisez chaque e-mail : Comment les modèles d'e-mails personnalisés de Firma.dev fonctionnent

Alt text: "Announcement graphic stating 'Firma.dev Now Speaks Greek' with two icons below: a colorful abstract design and a Greek flag, on a dark background."

Lorsque vous intégrez des signatures électroniques dans votre produit, vos clients ne doivent pas savoir quelle plateforme l'alimente. L'expérience de signature doit vous sembler propre, y compris chaque email automatisé qui est envoyé pendant le processus. Firma.dev vous permet désormais de personnaliser chaque email de notification envoyé par la plateforme en votre nom, avec un contrôle total sur les lignes d'objet, les corps HTML et les substitutions par espace de travail.

Vos Clients Voient Votre Marque, Pas La Nôtre

Chaque flux de travail de signature déclenche une série d'emails automatisés : l'invitation initiale, la notification au prochain signataire dans un flux séquentiel, les avis d'expiration, les messages d'annulation et les notifications de refus. Avant les modèles d'email personnalisés, tous étaient envoyés avec la copie et le formatage par défaut de Firma.dev.

Vous contrôlez maintenant les cinq :

Type d'Email

Quand Il Est Envoyé

signing_invite

Lorsqu'une demande de signature est envoyée pour la première fois à un destinataire

next_signer

Quand c'est au tour du prochain signataire dans un ordre de signature

signing_expired

Lorsqu'une demande de signature expire

signing_cancelled

Lorsqu'un expéditeur annule une demande de signature

signing_declined

Lorsqu'un signataire refuse de signer

La ligne d'objet (texte brut, max 500 caractères) et le corps (HTML, max 50,000 caractères) sont entièrement personnalisables pour chaque type. Vous pouvez faire correspondre exactement le ton, la mise en page, les couleurs et le contenu de votre marque.

Espaces Réservés Dynamiques

Les modèles prennent en charge une syntaxe {{placeholder}} permettant d'injecter des valeurs en direct au moment de l'envoi. La liste complète des espaces réservés disponibles est accessible via GET /email-templates/placeholders, et inclut ceux que vous utiliserez le plus :

  • {{signing_link}} — le lien unique du signataire pour accéder au document

  • {{signer_name}} — le nom du destinataire

  • {{document_name}} — le nom de la demande de signature

Un exemple pratique d'un corps 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>

Note pour le développeur : si le corps de votre modèle n'inclut pas {{signing_link}}, l'API retourne un avertissement lors de l'enregistrement. L'enregistrement réussit toujours, mais l'avertissement est là pour détecter l'erreur avant qu'un signataire ne reçoive un email sans moyen d'accéder à son document.

Modèles au Niveau de l'Entreprise et de l'Espace de Travail

Le système de modèles utilise une hiérarchie à trois niveaux : le modèle d'espace de travail prévaut, puis le modèle d'entreprise, puis le défaut intégré de Firma.dev. Cela vous offre deux modèles d'intégration naturels.

Définition d'un Modèle Défaillant au Niveau de l'Entreprise

Définissez votre modèle de marque une fois au niveau de l'entreprise et il s'applique à chaque espace de travail qui n'a pas son propre remplacement. Le modèle de point de terminaison du journal des modifications de l'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>"
}

Remplacement par Espace de Travail

Pour les partenaires utilisant le modèle d'espace de travail client de Firma.dev, chaque espace de travail peut avoir ses propres modèles d'email. Cet exemple curl provient du guide de marque blanche :

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 espace de travail desservant des clients en Allemagne pourrait utiliser des modèles en langue allemande avec la marque spécifique de ce client, tandis qu'un autre espace de travail utilise les défauts de votre entreprise.

Supprimer un modèle d'espace de travail le remet au défaut au niveau de l'entreprise. Supprimer le modèle d'entreprise le remet au défaut intégré de Firma.dev. La chaîne de secours a toujours quelque chose sur lequel atterrir.

Référence Complète de l'API

Point de terminaison

Description

GET /company/email-templates

Lister tous les modèles au niveau de l'entreprise

PUT /company/email-templates/{email_type}

Créer ou mettre à jour un modèle d'entreprise

DELETE /company/email-templates/{email_type}

Supprimer un modèle d'entreprise

GET /workspace/{id}/email-templates

Lister tous les modèles d'espace de travail

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

Obtenir un modèle d'espace de travail spécifique

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

Créer ou mettre à jour un modèle d'espace de travail

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

Supprimer un modèle d'espace de travail

GET /email-templates/defaults/{language}

Obtenir les défauts intégrés pour une langue

GET /email-templates/placeholders

Obtenir tous les espaces réservés disponibles

Le point de terminaison GET /email-templates/defaults/{language} est particulièrement utile comme point de départ : récupérez le modèle intégré pour votre langue cible, personnalisez-le, et enregistrez-le. Pas besoin de rédiger des emails depuis zéro.

Commencer

Les modèles d'email personnalisés sont disponibles à partir de l'API v1.8.0 et suivantes sans changements disruptifs. Si vous êtes déjà intégré, vous pouvez commencer à personnaliser les emails dès aujourd'hui sans toucher à la logique des demandes de signature existantes.

Commencez avec Firma.dev gratuitement, sans carte de crédit requise. Toutes les demandes de signature sont à 0,029 par enveloppe, sans minimum mensuel.

  1. Titre

Background Image

Prêt à ajouter des signatures électroniques à votre application ?

Commencez gratuitement. Aucune carte de crédit requise. Payez seulement 0,029 € par enveloppe lorsque vous êtes prêt à passer en direct.

Background Image

Prêt à ajouter des signatures électroniques à votre application ?

Commencez gratuitement. Aucune carte de crédit requise. Payez seulement 0,029 € par enveloppe lorsque vous êtes prêt à passer en direct.

Background Image

Prêt à ajouter des signatures électroniques à votre application ?

Commencez gratuitement. Aucune carte de crédit requise. Payez seulement 0,029 € par enveloppe lorsque vous êtes prêt à passer en direct.