Zum Hauptinhalt springen
PATCH
cURL
Verwenden Sie PATCH für Teilaktualisierungen. Um einen Fragebogen umzubenennen, senden Sie nur title oder description.
Um Fragen zu aktualisieren, senden Sie das vollständige gewünschte form_elements-Array. Dies ersetzt die bisherige Fragenliste. Behalten Sie bestehende Fragen bei, die Sie weiterhin anzeigen möchten.
Die v3-API unterstützt nur einfache lineare Fragebögen. Sie lehnt graph, branches, next und bedingte Regeln ab. Die Antwort enthält questionnaire_id. Wenn Sie einen published-Fragebogen aktualisieren, kann die API eine neue Version erstellen. Speichern Sie die zurückgegebene questionnaire_id und verwenden Sie sie in Workflows, statt anzunehmen, dass die ID in der URL weiterhin die neueste Version ist.

Autorisierungen

x-api-key
string
header
erforderlich

Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese- oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde, der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als null. Siehe https://docs.didit.me/console/api-keys.

Pfadparameter

questionnaire_uuid
string<uuid>
erforderlich

Versionsspezifische UUID des zu aktualisierenden Fragebogens.

Body

application/json

Fragebogen-Metadaten aktualisieren oder die vollständige lineare Liste von form_elements ersetzen.

title
string
description
string | null
languages
string[]
default_language
string
is_active
boolean
status
enum<string>
Verfügbare Optionen:
draft,
published
form_elements
object[]

Falls angegeben, ersetzt dies die vollständige lineare Fragenliste.

Minimum array length: 1

Antwort

Fragebogen aktualisiert. Der Body stellt den neuesten Status der resultierenden Version dar — die direkt aktualisierte Version oder die neu erstellte veröffentlichte Version, wenn Sie status: "published" für eine veröffentlichte Zeile übermittelt haben (in diesem Fall weichen questionnaire_id und version von denen ab, die Sie gepatcht haben). Die questionnaire_id in der Antwort ist die versionsspezifische UUID; verwenden Sie questionnaire_group_id, wenn Sie die stabile Gruppenkennung benötigen.

Vollständige Fragebogendetails, die von den Endpoints GET, POST (Erstellen) und PATCH (Aktualisieren) zurückgegeben werden.

questionnaire_id
string<uuid>

Eindeutige Kennung des Fragebogens. Verwenden Sie diese ID, wenn Sie aus einem Workflow oder in nachfolgenden Update-/Löschanfragen auf den Fragebogen verweisen.

title
string
description
string | null
languages
string[]
default_language
string
is_active
boolean
is_simple_questionnaire
boolean
graph
object

Graphstruktur mit start_node und nodes-Map.

sections
object[]

In Abschnitte gruppierter Fragebogeninhalt (aus dem Graph abgeleitet).

questionnaire_group_id
string<uuid>

Stabile Kennung, die alle Versionen desselben Fragebogens gruppiert.

version
integer
status
enum<string>
Verfügbare Optionen:
draft,
published
published_at
string<date-time> | null
is_editable
boolean

True, wenn der Fragebogen noch direkt bearbeitet werden kann (Entwurfsversionen).

Zuletzt geändert am 7. November 2026