Guides

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

Texte alternatif : « Interface au thème sombre affichant un panneau de notifications personnalisable. Le texte indique « Personnalisez tout », avec « Tout » entouré en violet, ce qui évoque la personnalisation. »

Lorsque vous intégrez des signatures électroniques dans votre produit, vos clients ne devraient pas savoir quelle plateforme les alimente. L'expérience de signature devrait sembler être la vôtre, y compris chaque e-mail automatisé envoyé pendant le processus. Firma.dev vous permet désormais de personnaliser chaque e-mail de notification que la plateforme envoie en votre nom, avec un contrôle total sur les lignes d'objet, les corps HTML et les remplacements par espace de travail.

Vos Clients Voient Votre Marque, Pas la Nôtre

Chaque flux de signature déclenche une série d'e-mails automatisés : l'invitation initiale, la notification du signataire suivant dans un flux séquentiel, les avis d'expiration, les messages d'annulation et les notifications de refus. Avant les modèles d'e-mails personnalisés, tous étaient envoyés avec le texte par défaut et le formatage de Firma.dev.

Maintenant, vous contrôlez 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 signataire suivant dans un ordre de signature

signing_expired

Lorsqu'une demande de signature expire

signing_cancelled

Quand un expéditeur annule une demande de signature

signing_declined

Quand 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 correspondre exactement au ton, à la mise en page, aux couleurs et au texte de votre marque.

Espaces Réservés Dynamiques

Les modèles prennent en charge une syntaxe {{placeholder}} pour 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 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>

Une note pour les développeurs : 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 tout de même, mais l'avertissement est là pour détecter l'erreur avant qu'un signataire ne reçoive un e-mail sans moyen d'accéder à son document.

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

Le système de modèle utilise une hiérarchie à trois niveaux : le modèle de l'espace de travail prend la priorité, puis le modèle de l'entreprise, puis le modèle par défaut intégré de Firma.dev. Cela vous donne deux schémas d'intégration naturels.

Définir un Modèle par Défaut au Niveau de l'Entreprise

Définissez votre modèle de marque une fois au niveau de l'entreprise et il s'applique à tout espace de travail qui n'a pas son propre remplacement. Le modèle de point de terminaison de la changelog 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'e-mails. Cet exemple de curl est extrait 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 servant des clients en Allemagne pourrait utiliser des modèles en allemand avec le branding spécifique de ce client, tandis qu'un autre espace de travail utilise vos paramètres par défaut au niveau de l'entreprise.

Supprimer un modèle d'espace de travail rétablit cet espace de travail au modèle par défaut au niveau de l'entreprise. Supprimer le modèle d'entreprise rétablit le modèle par défaut intégré de Firma.dev. La chaîne de secours a toujours quelque chose à atterrir.

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

Endpoint

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 modèles par défaut 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 : tirez le modèle intégré pour votre langue cible, personnalisez-le et enregistrez-le à nouveau. Pas besoin d'écrire le texte de l'e-mail à partir de zéro.

Prise En Main

Les modèles d'e-mails personnalisés sont disponibles à partir de l'API v1.8.0 sans changements de rupture. Si vous êtes déjà intégré, vous pouvez commencer à personnaliser les e-mails dès aujourd'hui sans toucher aucune logique de demande de signature existante.

Commencez gratuitement avec Firma.dev, aucune carte de crédit requise. Tous les envois de demandes de signature coûtent 0,029 par enveloppe, sans minimum mensuel.

  1. Titre

Image de fond

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.

Image de fond

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.

Image de fond

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.