Signaturprofil anlegen

Ein Signaturprofil bestimmt, in welchem Auftritt die signierende Person die Signaturanfrage per E-Mail erhält. Je Konto sind mehrere Profile möglich; die Umgebung folgt dem API-Schlüssel. Erforderlich ist signature_profiles:write.

Beschreibung

Legt ein Signaturprofil für Absendername, Logo und Redirect der Signaturanfrage an.

Parameter

Idempotency-KeyheaderPflicht

Eindeutiger Schlüssel für diese Anlage. Bei Retries unverändert wiederverwenden.

Beispiel: signature-profile-standard-v1

Request-Body

Der Body wird als application/json übertragen. Verwenden Sie ausschließlich die dokumentierten Feldnamen.

Request-Felder

Feld	Typ	Angabe	Beschreibung
`display_name`	string	Pflicht	Absendername der Signaturanfrage, wie ihn die signierende Person sieht; maximal 160 Zeichen.
`name`	string	Optional	Interne Bezeichnung; erscheint nicht in der Signaturanfrage. Maximal 120 Zeichen.
`redirect_url`	string	Optional	http(s)-Ziel, auf das die signierende Person nach Abschluss geleitet wird.

{
  "display_name": "Autohaus Beispiel GmbH",
  "name": "Standardprofil",
  "redirect_url": "https://autohaus-beispiel.de/zulassung/abgeschlossen"
}

SchemaquelleOpenAPI 3.1 herunterladen

Responses

201

Signaturprofil angelegt und sofort in Anträgen referenzierbar.

409

Idempotenzkonflikt: derselbe Schlüssel wurde mit einem anderen Body verwendet.

422

display_name fehlt oder redirect_url ist keine http(s)-URL.

Response-Body

Content-Type: application/json. Die erfolgreiche Antwort enthält die nachfolgend beschriebenen Felder.

Response-Felder

Feld	Typ	Angabe	Beschreibung
`id`	string	Immer	Öffentliche Signaturprofil-ID.
`object`	string	Immer	Konstanter Wert `signature_profile`.
`environment`	enum	Immer	`test` oder `live`.
`livemode`	boolean	Immer	`true` bei Produktivprofilen.
`name`	string	Optional	Interne Bezeichnung.
`display_name`	string	Immer	Absendername der Signaturanfrage.
`redirect_url`	string	Optional	Redirect-Ziel nach Abschluss der Signatur.
`has_logo`	boolean	Immer	Gibt an, ob ein Logo hinterlegt ist.
`logo_url`	string	Optional	Relativer Pfad der gespeicherten Logodatei.
`created_at`	date-time	Immer	Erstellungszeitpunkt.
`updated_at`	date-time	Immer	Letzter Änderungszeitpunkt.

{
  "id": "sgp_test_6f708192a3b4c5d6e7f8091a",
  "object": "signature_profile",
  "environment": "test",
  "livemode": false,
  "name": "Standardprofil",
  "display_name": "Autohaus Beispiel GmbH",
  "redirect_url": "https://autohaus-beispiel.de/zulassung/abgeschlossen",
  "has_logo": false,
  "created_at": "2026-08-27T09:30:00+02:00",
  "updated_at": "2026-08-27T09:30:00+02:00"
}

Profil je Antrag mitgeben

Übergeben Sie die Profil-ID beim Anlegen eines Antrags als signature_profile_id. Erfordert der Antrag eine Signatur, folgen Absender und Gestaltung der Signaturanfrage dem Profil. Ohne Profilangabe gilt das Konto-Signaturprofil aus dem Dashboard.

{ "id": "sgp_test_6f708192a3b4c5d6e7f8091a", "object": "signature_profile", "environment": "test", "livemode": false, "name": "Standardprofil", "display_name": "Autohaus Beispiel GmbH", "redirect_url": "https://autohaus-beispiel.de/zulassung/abgeschlossen", "has_logo": false, "created_at": "2026-08-27T09:30:00+02:00", "updated_at": "2026-08-27T09:30:00+02:00" }