Dokumentation

API-Referenz

PATCH/api/v1/signature-profiles/{signature_profile_id}

Signaturprofil aktualisieren

Senden Sie nur die zu ändernden Felder; name und redirect_url lassen sich mit null entfernen. Bereits versendete Signaturanfragen bleiben unverändert. Erforderlich ist signature_profiles:write.

Beschreibung

Aktualisiert Absendername, Bezeichnung und Redirect-Ziel eines Profils.

Parameter

signature_profile_idpathPflicht

Öffentliche Signaturprofil-ID.

Beispiel: sgp_test_6f708192a3b4c5d6e7f8091a

Request-Body

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

Request-Felder

FeldTypAngabeBeschreibung
display_namestringOptionalNeuer Absendername; darf nicht leer sein.
namestring|nullOptionalnull entfernt die interne Bezeichnung.
redirect_urlstring|nullOptionalnull entfernt das Redirect-Ziel.
remove_logobooleanOptionalEntfernt ein hinterlegtes Logo.
Request-Beispieljson
{
  "display_name": "Autohaus Beispiel AG",
  "redirect_url": null
}

Responses

200

Aktualisiertes Signaturprofil.

422

display_name wurde geleert 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

FeldTypAngabeBeschreibung
idstringImmerÖffentliche Signaturprofil-ID.
objectstringImmerKonstanter Wert signature_profile.
environmentenumImmertest oder live.
livemodebooleanImmertrue bei Produktivprofilen.
namestringOptionalInterne Bezeichnung.
display_namestringImmerAbsendername der Signaturanfrage.
redirect_urlstringOptionalRedirect-Ziel nach Abschluss der Signatur.
has_logobooleanImmerGibt an, ob ein Logo hinterlegt ist.
logo_urlstringOptionalRelativer Pfad der gespeicherten Logodatei.
created_atdate-timeImmerErstellungszeitpunkt.
updated_atdate-timeImmerLetzter Änderungszeitpunkt.
200 Response-Beispieljson
{
  "id": "sgp_test_6f708192a3b4c5d6e7f8091a",
  "object": "signature_profile",
  "environment": "test",
  "livemode": false,
  "name": "Standardprofil",
  "display_name": "Autohaus Beispiel AG",
  "has_logo": false,
  "created_at": "2026-08-27T09:30:00+02:00",
  "updated_at": "2026-08-27T09:30:00+02:00"
}

Wirkung auf Anträge

Änderungen wirken auf künftige Signaturanfragen aller Anträge, die das Profil referenzieren. Eine bereits versendete Signaturanfrage behält Absender und Gestaltung des Versandzeitpunkts.

Zum Öffnen eines Treffers Enter drücken.