> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Fragebogen-API aktualisieren: KYC-Formular bearbeiten

> Mit der Didit-API einen KYC-Fragebogen bearbeiten: umbenennen, geordnete Fragen ersetzen und mehrsprachige Labels aktualisieren. Pay-per-Call.



Prompt: Fragebogen-API aktualisieren
        Prompt in die Zwischenablage kopieren



      
      

\<pre>

\`Update a simple Didit questionnaire through the Management API.

Endpoint:
PATCH https://verification.didit.me/v3/questionnaires/{questionnaire_uuid}/

Authentication:
Use the x-api-key header with my Didit API key.

Requirements:
\- Use PATCH and include only the fields I want to change.
\- To rename the questionnaire, send title or description only.
\- To change questions, send the full desired form_elements array. This replaces the existing question list.
\- Do not send graph, branches, next, required_if, or conditional logic.
\- Keep languages consistent with the questionnaire. Include en labels for every form element.
\- Capture the questionnaire_id returned by the response because published updates may return a new version id.

Example metadata update body:
\{
"title": "Updated Customer Onboarding"
}

Example full question replacement body:
\{
"form_elements": [
\{
  "id": "occupation",
  "element_type": "short_text",
  "label": { "en": "What is your occupation?" },
  "is_required": true
},
\{
  "id": "source_of_funds",
  "element_type": "multiple_choice",
  "label": { "en": "Source of funds" },
  "options": [
    \{ "value": "employment", "label": { "en": "Employment" } },
    \{ "value": "business", "label": { "en": "Business" } }
  ]
}
]
}

Build the API call, handle validation errors, and return the latest questionnaire_id from the response.`

\</pre>



      
      

Einfügen in

Verwenden Sie `PATCH` für Teilaktualisierungen. Um einen Fragebogen umzubenennen, senden Sie nur `title` oder `description`.```json theme={null}
{
  "title": "Updated Customer Onboarding"
}
```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.```json theme={null}
{
  "form_elements": [
    {
      "id": "occupation",
      "element_type": "short_text",
      "label": { "en": "What is your occupation?" },
      "is_required": true
    },
    {
      "id": "source_of_funds",
      "element_type": "multiple_choice",
      "label": { "en": "Source of funds" },
      "options": [
        { "value": "employment", "label": { "en": "Employment" } },
        { "value": "business", "label": { "en": "Business" } }
      ]
    }
  ]
}
```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.


## OpenAPI

````yaml de/openapi-25.json PATCH /v3/questionnaires/{questionnaire_uuid}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API für Ausweisverifizierung. Authentifizierung über den x-api-key-Header.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/questionnaires/{questionnaire_uuid}/:
    patch:
      tags:
        - Questionnaires
      summary: Fragebogen aktualisieren
      description: >-
        Fragebogen aktualisieren. Die Versionierung hängt vom übergebenen
        `status`-Feld und dem aktuellen Status der Version ab: (1) kein `status`
        bei einer **veröffentlichten** Version → die veröffentlichte Version
        wird direkt aktualisiert (gleiche `questionnaire_id`, gleiche
        `version`); (2) kein `status` bei einem **Entwurf** → der Entwurf wird
        aktualisiert und sofort veröffentlicht; (3) `status: "published"` bei
        einer **veröffentlichten** Version → eine NEUE veröffentlichte Version
        wird unter derselben `questionnaire_group_id` erstellt (neue
        `questionnaire_id`, `version` + 1) und zurückgegeben, und jeder
        vorhandene Entwurf in der Gruppe wird gelöscht; (4) `status: "draft"`
        belässt einen Entwurf als Entwurf (automatische Speicherung), wird
        jedoch bei einer veröffentlichten Version mit 400 abgelehnt (`"Cannot
        revert a published version to draft."`).
      operationId: update_questionnaire
      parameters:
        - name: questionnaire_uuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Versionsspezifische UUID des zu aktualisierenden Fragebogens.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimpleQuestionnaireUpdateRequest'
            examples:
              Rename:
                summary: Fragebogen umbenennen
                value:
                  title: Updated Customer Onboarding
              Replace questions:
                summary: Vollständige lineare Fragenliste ersetzen
                value:
                  form_elements:
                    - id: occupation
                      element_type: short_text
                      label:
                        en: What is your occupation?
                      is_required: true
                    - id: source_of_funds
                      element_type: multiple_choice
                      label:
                        en: Source of funds
                      options:
                        - value: employment
                          label:
                            en: Employment
                        - value: business
                          label:
                            en: Business
      responses:
        '200':
          description: >-
            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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuestionnaireDetail'
        '400':
          description: >-
            Validierungsfehler — unbekannter `element_type`, fehlende
            Übersetzung, nicht unterstützte Verzweigungs-/Bedingungsfelder,
            `languages` enthält kein `en`, `default_language` nicht in
            `languages`, Option ohne Label, Senden eines unverarbeiteten `graph`
            oder `status: "draft"` für eine veröffentlichte Version (`"Cannot
            revert a published version to draft."`). Der Antwort-Body ist ein
            DRF-Validierungsfehler mit Feldnamen als Schlüsseln.
        '403':
          description: API-Schlüssel fehlt oder ist ungültig.
          content:
            application/json:
              examples:
                Invalid token:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            Für die authentifizierte Anwendung existiert kein Fragebogen mit
            dieser `questionnaire_uuid`.
        '415':
          description: >-
            Nicht unterstützter Medientyp. Setzen Sie `Content-Type:
            application/json`.
        '429':
          description: >-
            Rate-Limit überschritten. Wiederholen Sie die Anfrage mit
            exponentiellem Backoff.
        '500':
          description: Unerwarteter Serverfehler. Kann sicher wiederholt werden.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: >-
            curl -X PATCH
            'https://verification.didit.me/v3/questionnaires/11111111-2222-3333-4444-555555555555/'
            \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"title": "Updated Customer Onboarding"}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.questionnaires.update(
                "11111111-2222-3333-4444-555555555555",
                title="Updated Customer Onboarding",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            const result = await
            didit.questionnaires.update("11111111-2222-3333-4444-555555555555",
            {
              title: "Updated Customer Onboarding",
            });

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Questionnaires.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SimpleQuestionnaireUpdateRequest{\n\tTitle: didit.String(\"Updated Customer Onboarding\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;

            import me.didit.types.SimpleQuestionnaireUpdateRequest;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.questionnaires().update("11111111-2222-3333-4444-555555555555",
            SimpleQuestionnaireUpdateRequest.builder()
                    .title("Updated Customer Onboarding")
                    .build());
            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $result =
            $didit->questionnaires->update('11111111-2222-3333-4444-555555555555',
            [
                'title' => 'Updated Customer Onboarding',
            ]);

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.questionnaires.update(
              "11111111-2222-3333-4444-555555555555",
              title: "Updated Customer Onboarding"
            )
            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await
            client.Questionnaires.UpdateAsync("11111111-2222-3333-4444-555555555555",
            new SimpleQuestionnaireUpdateRequest

            {
                Title = "Updated Customer Onboarding",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    SimpleQuestionnaireUpdateRequest:
      type: object
      description: >-
        Fragebogen-Metadaten aktualisieren oder die vollständige lineare Liste
        von `form_elements` ersetzen.
      properties:
        title:
          type: string
        description:
          type: string
          nullable: true
        languages:
          type: array
          items:
            type: string
        default_language:
          type: string
        is_active:
          type: boolean
        status:
          type: string
          enum:
            - draft
            - published
        form_elements:
          type: array
          minItems: 1
          description: Falls angegeben, ersetzt dies die vollständige lineare Fragenliste.
          items:
            $ref: '#/components/schemas/SimpleQuestionnaireElement'
    QuestionnaireDetail:
      type: object
      description: >-
        Vollständige Fragebogendetails, die von den Endpoints GET, POST
        (Erstellen) und PATCH (Aktualisieren) zurückgegeben werden.
      properties:
        questionnaire_id:
          type: string
          format: uuid
          description: >-
            Eindeutige Kennung des Fragebogens. Verwenden Sie diese ID, wenn Sie
            aus einem Workflow oder in nachfolgenden Update-/Löschanfragen auf
            den Fragebogen verweisen.
        title:
          type: string
        description:
          type: string
          nullable: true
        languages:
          type: array
          items:
            type: string
        default_language:
          type: string
        is_active:
          type: boolean
        is_simple_questionnaire:
          type: boolean
        graph:
          type: object
          description: Graphstruktur mit start_node und nodes-Map.
        sections:
          type: array
          description: >-
            In Abschnitte gruppierter Fragebogeninhalt (aus dem Graph
            abgeleitet).
          items:
            type: object
        questionnaire_group_id:
          type: string
          format: uuid
          description: Stabile Kennung, die alle Versionen desselben Fragebogens gruppiert.
        version:
          type: integer
        status:
          type: string
          enum:
            - draft
            - published
        published_at:
          type: string
          format: date-time
          nullable: true
        is_editable:
          type: boolean
          description: >-
            True, wenn der Fragebogen noch direkt bearbeitet werden kann
            (Entwurfsversionen).
    SimpleQuestionnaireElement:
      type: object
      required:
        - element_type
        - label
      properties:
        id:
          type: string
          description: >-
            Optionale stabile Fragen-ID. Wenn sie weggelassen wird, generiert
            die API `q1`, `q2` usw. Verwenden Sie zur besseren Lesbarkeit
            Kleinbuchstaben, Zahlen und Unterstriche.
          example: source_of_funds
        element_type:
          type: string
          description: >-
            Fragetyp. Die API akzeptiert diese Werte in Kleinbuchstaben und
            deren Entsprechungen in Großbuchstaben.
          enum:
            - short_text
            - long_text
            - dropdown
            - single_choice
            - multiple_choice
            - number
            - image
            - file_upload
            - time
            - email
            - address
            - phone
            - country
            - date_picker
            - consent
            - section_header
            - separator
            - heading
            - paragraph
        label:
          type: object
          description: >-
            Fragebezeichnung nach Sprachcode, zum Beispiel `{ "en": "Source of
            funds" }`.
          additionalProperties:
            type: string
        description:
          type: object
          nullable: true
          additionalProperties:
            type: string
        placeholder:
          type: object
          nullable: true
          additionalProperties:
            type: string
        is_required:
          type: boolean
          default: false
        options:
          type: array
          description: >-
            Für `dropdown`, `single_choice` und `multiple_choice` verwenden.
            Wenn `value` weggelassen wird, generiert die API einen Wert aus der
            Optionsbezeichnung.
          items:
            type: object
            required:
              - label
            properties:
              value:
                type: string
              label:
                type: object
                additionalProperties:
                  type: string
        max_files:
          type: integer
          minimum: 1
          maximum: 5
          description: Mit `file_upload` oder `image` verwenden.
        validation:
          type: object
          nullable: true
          description: >-
            Optionale Formatvalidierung für `short_text`, `long_text` oder
            `number`. Wird erzwungen, während der Benutzer das Feld ausfüllt (er
            kann nicht fortfahren, bis die Validierung erfolgreich ist), und bei
            der Übermittlung von der API erneut geprüft.
          properties:
            pattern:
              type: string
              description: >-
                Regulärer Ausdruck (ECMA-262-Teilmenge), mit dem der Wert
                vollständig übereinstimmen muss. Für `short_text` und
                `long_text`. Keine ^/$-Anker hinzufügen; der gesamte Wert wird
                abgeglichen.
            min_length:
              type: integer
              minimum: 0
              description: Mindestanzahl von Zeichen. Für `short_text` und `long_text`.
            max_length:
              type: integer
              minimum: 0
              description: Maximale Zeichenanzahl. Für `short_text` und `long_text`.
            min:
              type: number
              description: Numerischer Mindestwert. Für `number`.
            max:
              type: number
              description: Maximaler numerischer Wert. Für `number`.
            error_message:
              type: object
              description: >-
                Übersetzte Nachricht, die bei fehlgeschlagener Validierung
                angezeigt wird, nach Sprachcode geschlüsselt.
              additionalProperties:
                type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.