Zum Hauptinhalt springen
POST
cURL
Verwenden Sie diesen Endpoint, um einfache Fragebögen über die API zu erstellen. Senden Sie ein form_elements-Array in der Reihenfolge, in der die Benutzer die Fragen beantworten sollen. Didit erstellt den internen Fragebogen-Graphen für Sie. Die API unterstützt nur einfache lineare Fragebögen. Senden Sie kein graph, keine branches, kein next und keine bedingten Regeln.

Pflichtfelder

  • title ist der interne Name des Fragebogens.
  • languages muss en enthalten.
  • form_elements muss mindestens eine Frage enthalten.
  • Jedes Formularelement benötigt einen element_type und ein übersetztes label.
Sie können einem Formularelement außerdem optional eine übersetzte description als Hilfetext hinzufügen. Sie wird bei allen Elementtypen außer separator akzeptiert und im Fragebogenbericht als description des Elements zurückgegeben.

Elementtypen

Verwenden Sie Werte in Kleinbuchstaben wie short_text, multiple_choice, email, file_upload oder date_picker. Großgeschriebene Enum-Werte wie SHORT_TEXT werden ebenfalls akzeptiert. Für dropdown, single_choice und multiple_choice fügen Sie options hinzu. Wenn Sie den value einer Option weglassen, erzeugt Didit einen Wert aus dem Label.

Feldvalidierung

Fügen Sie einem short_text-, long_text- oder number-Element ein optionales validation-Objekt hinzu, um ein Format für die Antwort des Benutzers zu erzwingen. Das ist nützlich für Kennungen mit strengen Formaten wie Steuernummern, nationalen Kennungen oder Kartennummern. Die Validierung läuft, während der Benutzer das Feld ausfüllt (der Benutzer kann erst fortfahren, wenn die Antwort die Validierung besteht), und wird bei der Übermittlung von der API erneut erzwungen.
Die Antwort enthält questionnaire_id. Speichern Sie diese ID, denn Sie verwenden sie als questionnaire_uuid, wenn Sie den Fragebogen einem Workflow hinzufügen.

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.

Body

application/json

Erstellen Sie einen einfachen linearen Fragebogen. Die API wandelt form_elements intern in den Fragebogen-Graphen um.

title
string
erforderlich

Interner Name für den Fragebogen.

languages
string[]
erforderlich

In jeder Bezeichnung enthaltene Sprachen. Muss en enthalten.

Beispiel:
form_elements
object[]
erforderlich

Fragen in der genauen Reihenfolge, in der Benutzer sie sehen sollen. Verzweigungen und bedingte Felder werden nicht unterstützt.

Minimum array length: 1
description
string | null
default_language
string

Standardsprache. Muss in languages enthalten sein.

Beispiel:

"en"

is_active
boolean
Standard:true
status
enum<string>

Lassen Sie dieses Feld weg, um einen veröffentlichten Fragebogen zu erstellen, der für Workflows bereit ist.

Verfügbare Optionen:
draft,
published

Antwort

Fragebogen erstellt. Die Antwort enthält die questionnaire_id — speichern Sie diese, um aus Workflows oder bei künftigen Update-/Löschaufrufen auf diesen Fragebogen zu verweisen.

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