White-Label Jede E-Mail: So funktionieren die individuellen E-Mail-Vorlagen von Firma.dev

Wenn Sie E-Signaturen in Ihr Produkt einbetten, sollten Ihre Kunden nicht wissen, welche Plattform dahintersteckt. Die Signiererfahrung sollte sich wie Ihre eigene anfühlen, einschließlich jeder automatisierten E-Mail, die während des Prozesses gesendet wird. Firma.dev ermöglicht es Ihnen jetzt, jede Benachrichtigungs-E-Mail, die die Plattform in Ihrem Namen sendet, anzupassen, mit vollständiger Kontrolle über Betreffzeilen, HTML-Inhalte und Workspace-Überschreibungen.

Ihre Kunden sehen Ihre Marke, nicht unsere

Jeder Signierungs-Workflow löst eine Reihe automatisierter E-Mails aus: die anfängliche Einladung, die Benachrichtigung des nächsten Signers in einem sequenziellen Ablauf, Ablaufbenachrichtigungen, Stornierungsnachrichten und Ablehnungsbenachrichtigungen. Vor benutzerdefinierten E-Mail-Vorlagen wurden diese alle mit der Standardkopie und -formatierung von Firma.dev versendet.

Jetzt haben Sie die Kontrolle über alle fünf:

Sowohl die Betreffzeile (nur Text, max. 500 Zeichen) als auch der Textkörper (HTML, max. 50.000 Zeichen) sind für jeden Typ vollständig anpassbar. Sie können den Ton, das Layout, die Farben und den Text Ihrer Marke genau anpassen.

Dynamische Platzhalter

Vorlagen unterstützen eine {{placeholder}}-Syntax, um zur Sendezeit Live-Werte einzufügen. Die vollständige Liste der verfügbaren Platzhalter ist über GET /email-templates/placeholders abrufbar und enthält die, die Sie am häufigsten verwenden werden:

• {{signing_link}} — der eindeutige Link des Signers zum Zugriff auf das Dokument

• {{signer_name}} — der Name des Empfängers

• {{document_name}} — der Name der Signaturanfrage

Ein praktisches Beispiel für den Textkörper einer 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>

Ein Entwicklerhinweis: Wenn Ihr Vorlagentextkörper {{signing_link}} nicht enthält, gibt die API beim Speichern eine Warnung aus. Das Speichern gelingt dennoch, aber die Warnung soll Sie auf den Fehler aufmerksam machen, bevor ein Signer eine E-Mail ohne Zugriff auf ihr Dokument erhält.

Unternehmens- und Workspace-Vorlagen

Das Vorlagensystem verwendet eine dreistufige Hierarchie: Workspace-Vorlage hat Vorrang, dann Unternehmensvorlage, dann die eingebauten Standards von Firma.dev. Dies gibt Ihnen zwei natürliche Integrationsmuster.

Unternehmensweiten Standard festlegen

Richten Sie einmal Ihre Marken-Vorlage auf Unternehmensebene ein, und sie gilt für jeden Workspace, der keine eigene Überschreibung hat. Das Endpunktmuster aus dem API-Änderungsprotokoll:

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>"
}

Überschreibung pro Workspace

Für Partner, die das Kunden-Workspace-Modell von Firma.dev verwenden, kann jeder Workspace seine eigenen E-Mail-Vorlagen haben. Dieses Curl-Beispiel stammt aus dem White-Label-Guide:

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>"
  }'

Ein Workspace, der Kunden in Deutschland bedient, könnte deutschsprachige Vorlagen mit dem spezifischen Branding dieses Kunden verwenden, während ein anderer Workspace Ihre unternehmensweiten Standards verwendet.

Das Löschen einer Workspace-Vorlage setzt diesen Workspace auf den unternehmensweiten Standard zurück. Das Löschen der Unternehmensvorlage setzt auf die eingebauten Standards von Firma.dev zurück. Die Rückfallkette hat immer etwas, worauf zurückgegriffen werden kann.

Vollständige API-Referenz

Der GET /email-templates/defaults/{language}-Endpunkt ist besonders nützlich als Ausgangspunkt: Holen Sie sich die eingebaute Vorlage für Ihre Zielsprache, passen Sie sie an und speichern Sie sie zurück. Keine Notwendigkeit, E-Mail-Texte von Grund auf neu zu schreiben.

Erste Schritte

Benutzerdefinierte E-Mail-Vorlagen sind ab API-Version 1.8.0 verfügbar, ohne dass Änderungen erforderlich sind. Wenn Sie bereits integriert sind, können Sie noch heute beginnen, E-Mails zu personalisieren, ohne die bestehende Logik der Signaturanfragen zu ändern.

Starten Sie mit Firma.dev kostenlos, keine Kreditkarte erforderlich. Alle Signieranfragen kosten 0,029 pro Umschlag, keine monatlichen Mindestgebühren.