> ## 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.

# API para actualizar cuestionarios: editar formulario KYC

> Edita un cuestionario KYC de Didit por API: cambia el nombre, reemplaza las preguntas y actualiza etiquetas en varios idiomas. Pago por llamada.



Prompt de la API para actualizar cuestionarios
        Copiar el prompt al portapapeles



      
      

\<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>



      
      

Pegar en

Usa `PATCH` para actualizaciones parciales. Para cambiar el nombre de un cuestionario, envía solo `title` o `description`.```json theme={null}
{
  "title": "Updated Customer Onboarding"
}
```Para actualizar las preguntas, envía el array `form_elements` completo tal como quieres que quede. Este reemplaza la lista de preguntas anterior. Conserva las preguntas existentes que todavía quieras mostrar.```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" } }
      ]
    }
  ]
}
```La API v3 solo admite cuestionarios lineales simples. Rechaza `graph`, `branches`, `next` y las reglas condicionales.La respuesta incluye `questionnaire_id`. Cuando actualizas un cuestionario `published`, la API puede crear una nueva versión. Guarda el `questionnaire_id` devuelto y úsalo en los flujos en lugar de suponer que el id de la URL sigue siendo la versión más reciente.


## OpenAPI

````yaml es/openapi-25.json PATCH /v3/questionnaires/{questionnaire_uuid}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificación de identidad. Autentícate con el encabezado x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/questionnaires/{questionnaire_uuid}/:
    patch:
      tags:
        - Questionnaires
      summary: Actualizar cuestionario
      description: >-
        Actualiza un cuestionario. El versionado depende del campo `status` que
        envíes y del estado actual de la versión: (1) sin `status` en una
        versión **publicada** → la versión publicada se actualiza en el mismo
        lugar (mismo `questionnaire_id`, misma `version`); (2) sin `status` en
        un **borrador** → el borrador se actualiza y se publica de inmediato;
        (3) `status: "published"` en una versión **publicada** → se crea y se
        devuelve una NUEVA versión publicada bajo el mismo
        `questionnaire_group_id` (nuevo `questionnaire_id`, `version` + 1), y se
        elimina cualquier borrador existente del grupo; (4) `status: "draft"`
        mantiene un borrador como borrador (guardado automático), pero se
        rechaza con 400 en una versión publicada (`"Cannot revert a published
        version to draft."`).
      operationId: update_questionnaire
      parameters:
        - name: questionnaire_uuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: UUID por versión del cuestionario que se va a actualizar.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimpleQuestionnaireUpdateRequest'
            examples:
              Rename:
                summary: Cambiar el nombre de un cuestionario
                value:
                  title: Updated Customer Onboarding
              Replace questions:
                summary: Reemplazar la lista lineal completa de preguntas
                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: >-
            Cuestionario actualizado. El cuerpo es el estado más reciente de la
            versión resultante: la versión actualizada en el mismo lugar, o la
            nueva versión publicada creada cuando enviaste `status: "published"`
            sobre una fila publicada (en ese caso, `questionnaire_id` y
            `version` difieren de los que modificaste). El `questionnaire_id` de
            la respuesta es el UUID de cada versión; usa
            `questionnaire_group_id` si necesitas el identificador estable del
            grupo.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuestionnaireDetail'
        '400':
          description: >-
            Error de validación: `element_type` desconocido, falta una
            traducción, campos de ramificación o condicionales no compatibles,
            falta `en` en `languages`, `default_language` no está en
            `languages`, una opción sin etiqueta, el envío de un `graph` sin
            procesar o `status: "draft"` en una versión publicada (`"Cannot
            revert a published version to draft."`). El cuerpo de la respuesta
            es un error de validación de DRF indexado por nombre de campo.
        '403':
          description: Falta la clave de API o no es válida.
          content:
            application/json:
              examples:
                Invalid token:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            No existe ningún cuestionario con este `questionnaire_uuid` para la
            aplicación autenticada.
        '415':
          description: >-
            Tipo de contenido no admitido. Define `Content-Type:
            application/json`.
        '429':
          description: Límite de solicitudes superado. Reintenta con retroceso exponencial.
        '500':
          description: Error inesperado del servidor. Se puede reintentar sin riesgo.
      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: >-
        Actualiza los metadatos del cuestionario o reemplaza la lista lineal
        completa de `form_elements`.
      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: >-
            Si se proporciona, sustituye por completo la lista lineal de
            preguntas.
          items:
            $ref: '#/components/schemas/SimpleQuestionnaireElement'
    QuestionnaireDetail:
      type: object
      description: >-
        Detalle completo del cuestionario que devuelven los endpoints GET, POST
        (crear) y PATCH (actualizar).
      properties:
        questionnaire_id:
          type: string
          format: uuid
          description: >-
            Identificador único del cuestionario. Usa este id para hacer
            referencia al cuestionario desde un flujo o en solicitudes
            posteriores de actualización o eliminación.
        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: Estructura de grafo con start_node y un mapa de nodos.
        sections:
          type: array
          description: >-
            Contenido del cuestionario agrupado en secciones (derivado del
            grafo).
          items:
            type: object
        questionnaire_group_id:
          type: string
          format: uuid
          description: >-
            Identificador estable que agrupa todas las versiones del mismo
            cuestionario.
        version:
          type: integer
        status:
          type: string
          enum:
            - draft
            - published
        published_at:
          type: string
          format: date-time
          nullable: true
        is_editable:
          type: boolean
          description: >-
            True cuando el cuestionario aún puede editarse directamente
            (versiones en borrador).
    SimpleQuestionnaireElement:
      type: object
      required:
        - element_type
        - label
      properties:
        id:
          type: string
          description: >-
            ID de pregunta estable y opcional. Si se omite, la API genera `q1`,
            `q2`, etc. Usa letras minúsculas, números y guiones bajos para
            facilitar la lectura.
          example: source_of_funds
        element_type:
          type: string
          description: >-
            Tipo de pregunta. La API acepta estos valores en minúsculas y sus
            equivalentes en mayúsculas.
          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: >-
            Etiqueta de la pregunta por código de idioma, por ejemplo `{ "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: >-
            Úsalo para `dropdown`, `single_choice` y `multiple_choice`. Si se
            omite `value`, la API genera uno a partir de la etiqueta de la
            opción.
          items:
            type: object
            required:
              - label
            properties:
              value:
                type: string
              label:
                type: object
                additionalProperties:
                  type: string
        max_files:
          type: integer
          minimum: 1
          maximum: 5
          description: Úsalo con `file_upload` o `image`.
        validation:
          type: object
          nullable: true
          description: >-
            Validación de formato opcional para `short_text`, `long_text` o
            `number`. Se aplica mientras el usuario rellena el campo (no puede
            continuar hasta que la supere) y la API la vuelve a comprobar al
            enviarlo.
          properties:
            pattern:
              type: string
              description: >-
                Expresión regular (subconjunto de ECMA-262) con la que el valor
                debe coincidir por completo. Para `short_text` y `long_text`. No
                añadas los anclajes ^/$; se compara el valor completo.
            min_length:
              type: integer
              minimum: 0
              description: Número mínimo de caracteres. Para `short_text` y `long_text`.
            max_length:
              type: integer
              minimum: 0
              description: Número máximo de caracteres. Para `short_text` y `long_text`.
            min:
              type: number
              description: Valor numérico mínimo. Para `number`.
            max:
              type: number
              description: Valor numérico máximo. Para `number`.
            error_message:
              type: object
              description: >-
                Mensaje traducido que se muestra cuando falla la validación,
                indexado por código de idioma.
              additionalProperties:
                type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clave de API de tu aplicación, que encontrarás en Developers -> API
        keys en la Business Console. La clave principal tiene acceso completo.
        Una clave con nombre puede tener un alcance limitado: ninguno, lectura o
        escritura por recurso, limitada a algunos flujos o a sesiones aprobadas,
        a una lista de direcciones IP y a una fecha de caducidad. 401 significa
        que la clave es incorrecta, se revocó o expiró; 403 significa que no se
        envió ninguna clave, que la clave no tiene acceso a este recurso o
        acción, o que la solicitud provino de una dirección fuera de su lista de
        IP; 404 en una ruta de sesión significa que la sesión está fuera de los
        flujos o estados de la clave. Una clave sin acceso a contenido
        multimedia recibe las URL de imágenes, videos y PDF como null, y una
        clave sin permiso de escritura en sesiones recibe los enlaces y tokens
        de sesión como null. Consulta https://docs.didit.me/console/api-keys.

````

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