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

Wenn Sie elektronische Signaturen in Ihr Produkt einbetten, sollten Ihre Kunden nicht wissen, welche Plattform es antreibt. Das Signaturerlebnis sollte sich wie Ihres anfühlen, einschließlich jeder automatisierten E-Mail, die während des Prozesses versendet wird. Firma.dev ermöglicht es Ihnen jetzt, jede Benachrichtigungs-E-Mail, die die Plattform in Ihrem Namen sendet, vollständig anzupassen, mit voller Kontrolle über Betreffzeilen, HTML-Körper und Bereinigungen pro Arbeitsbereich.

Ihre Kunden sehen Ihre Marke, nicht unsere

Jeder Signatur-Workflow löst eine Reihe von automatisierten E-Mails aus: die anfängliche Einladung, die Benachrichtigung des nächsten Unterzeichners in einer sequentiellen Abfolge, Fristmitteilungen, Stornierungsnachrichten und Ablehnungsbenachrichtigungen. Vor der Anpassung von E-Mail-Vorlagen wurden diese alle mit der Standardkopie und -formatierung von Firma.dev versendet.

Jetzt kontrollieren Sie alle fünf:

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

Dynamische Platzhalter

Vorlagen unterstützen eine {{placeholder}}-Syntax zum Einfügen von Live-Werten zum Sendezeitpunkt. Die vollständige Liste der verfügbaren Platzhalter ist über GET /email-templates/placeholders verfügbar und umfasst die am häufigsten verwendeten:

• {{signing_link}} — der eindeutige Link des Unterzeichners, um auf das Dokument zuzugreifen

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

• {{document_name}} — der Name der Signaturanfrage

Ein praktisches Beispiel für einen signing_invite-Körper:

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

Eine Entwicklernotiz: Wenn Ihr Vorlagenkörper {{signing_link}} nicht enthält, gibt die API beim Speichern eine Warnung aus. Das Speichern ist dennoch erfolgreich, aber die Warnung ist da, um den Fehler zu erkennen, bevor ein Unterzeichner eine E-Mail ohne Zugang zu seinem Dokument erhält.

Unternehmens- und Arbeitsbereichs-Level Vorlagen

Das Vorlagensystem verwendet eine dreistufige Hierarchie: Die Arbeitsbereichsvorlage hat Vorrang, dann die Unternehmensvorlage und dann Firma.devs eingebaute Standardeinstellung. Dies gibt Ihnen zwei natürliche Integrationsmuster.

Festlegen einer unternehmensweiten Standardeinstellung

Legen Sie Ihre gebrandete Vorlage einmal auf Unternehmensebene fest und es gilt für jeden Arbeitsbereich, der keine eigene Override 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 Arbeitsbereich

Für Partner, die das Kundenarbeitsbereich-Modell von Firma.dev verwenden, kann jeder Arbeitsbereich seine eigenen E-Mail-Vorlagen haben. Dieses Curl-Beispiel stammt aus der White-Labeling-Anleitung:

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 Arbeitsbereich, der Kunden in Deutschland bedient, könnte deutsche Sprachvorlagen mit der spezifischen Markenidentität dieses Kunden verwenden, während ein anderer Arbeitsbereich Ihre unternehmensweiten Standardeinstellungen nutzt.

Das Löschen einer Arbeitsbereichsvorlage setzt diesen Arbeitsbereich auf die Unternehmensvorlage zurück. Das Löschen der Unternehmensvorlage setzt sie auf die eingebaute Standardeinstellung von Firma.dev zurück. Die Rückfallkette hat immer etwas, worauf sie zurückgreifen kann.

Umfassende API-Referenz

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

Erste Schritte

Angepasste E-Mail-Vorlagen sind ab API v1.8.0 ohne Änderungen mit Komplikationen verfügbar. Wenn Sie bereits integriert sind, können Sie heute damit beginnen, E-Mails anzupassen, ohne bereits bestehende Signaturanfrage-Logik zu verändern.

Starten Sie kostenlos mit Firma.dev, keine Kreditkarte erforderlich. Alle Signaturanfragen kosten 0,029 pro Umschlag, keine monatlichen Mindestbeträge.