> ## 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. # Atualizar questionário via API: editar formulário KYC > Edite um questionário KYC da Didit: renomeie, substitua perguntas ordenadas e atualize rótulos em vários idiomas. Pago por chamada. Prompt da API de atualização de questionário Copiar o prompt para a área de transferência \

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

\
Colar em Use `PATCH` para atualizações parciais. Para renomear um questionário, envie apenas `title` ou `description`.```json theme={null} { "title": "Updated Customer Onboarding" } ```Para atualizar as perguntas, envie o array `form_elements` completo, como você quer que ele fique. Ele substitui a lista de perguntas anterior. Mantenha todas as perguntas existentes que você ainda quer exibir.```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" } } ] } ] } ```A API v3 só aceita questionários lineares simples. Ela rejeita `graph`, `branches`, `next` e regras condicionais.A resposta inclui `questionnaire_id`. Quando você atualiza um questionário `published`, a API pode criar uma nova versão. Guarde o `questionnaire_id` retornado e use-o nos fluxos, em vez de presumir que o id na URL ainda é a versão mais recente. ## OpenAPI ````yaml pt-br/openapi-25.json PATCH /v3/questionnaires/{questionnaire_uuid}/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de verificação de identidade. Autentique-se com o cabeçalho x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/questionnaires/{questionnaire_uuid}/: patch: tags: - Questionnaires summary: Atualizar questionário description: >- Atualiza um questionário. O versionamento depende do campo `status` que você envia e do estado atual da versão: (1) sem `status` em uma versão **publicada** → a versão publicada é atualizada no próprio lugar (mesmo `questionnaire_id`, mesma `version`); (2) sem `status` em um **rascunho** → o rascunho é atualizado e publicado imediatamente; (3) `status: "published"` em uma versão **publicada** → uma NOVA versão publicada é criada sob o mesmo `questionnaire_group_id` (novo `questionnaire_id`, `version` + 1) e retornada, e qualquer rascunho existente no grupo é excluído; (4) `status: "draft"` mantém um rascunho como rascunho (salvamento automático), mas é rejeitado com 400 em uma versão 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 da versão do questionário a ser atualizada. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SimpleQuestionnaireUpdateRequest' examples: Rename: summary: Renomear um questionário value: title: Updated Customer Onboarding Replace questions: summary: Substituir a lista linear completa de perguntas 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: >- Questionário atualizado. O corpo é o estado mais recente da versão resultante: a versão atualizada no próprio registro, ou a nova versão publicada criada quando você enviou `status: "published"` em um registro publicado (nesse caso, `questionnaire_id` e `version` diferem dos que você atualizou). O `questionnaire_id` na resposta é o UUID por versão; use `questionnaire_group_id` se precisar do identificador estável do grupo. content: application/json: schema: $ref: '#/components/schemas/QuestionnaireDetail' '400': description: >- Erro de validação: `element_type` desconhecido, tradução ausente, campos de ramificação/condicionais não suportados, `languages` sem `en`, `default_language` fora de `languages`, opção sem rótulo, envio de um `graph` bruto ou `status: "draft"` em uma versão publicada (`"Cannot revert a published version to draft."`). O corpo da resposta é um erro de validação do DRF com chaves por nome de campo. '403': description: Chave de API ausente ou inválida. content: application/json: examples: Invalid token: value: detail: You do not have permission to perform this action. '404': description: >- Não existe nenhum questionário com este `questionnaire_uuid` para a aplicação autenticada. '415': description: >- Tipo de mídia não suportado. Defina `Content-Type: application/json`. '429': description: >- Limite de requisições excedido. Tente novamente com backoff exponencial. '500': description: Erro inesperado do servidor. É seguro tentar novamente. 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: >- 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: >- Atualize os metadados do questionário ou substitua a lista linear completa `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: Se informado, substitui toda a lista linear de perguntas. items: $ref: '#/components/schemas/SimpleQuestionnaireElement' QuestionnaireDetail: type: object description: >- Detalhes completos do questionário retornados pelos endpoints GET, POST (criação) e PATCH (atualização). properties: questionnaire_id: type: string format: uuid description: >- Identificador único do questionário. Use este id ao referenciar o questionário a partir de um fluxo ou em requisições posteriores de atualização/exclusão. 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: Estrutura de grafo com start_node e o mapa de nós. sections: type: array description: Conteúdo do questionário agrupado em seções (derivado do grafo). items: type: object questionnaire_group_id: type: string format: uuid description: >- Identificador estável que agrupa todas as versões do mesmo questionário. version: type: integer status: type: string enum: - draft - published published_at: type: string format: date-time nullable: true is_editable: type: boolean description: >- True quando o questionário ainda pode ser editado diretamente (versões de rascunho). SimpleQuestionnaireElement: type: object required: - element_type - label properties: id: type: string description: >- ID estável opcional da pergunta. Se omitido, a API gera `q1`, `q2` etc. Use letras minúsculas, números e sublinhados para facilitar a leitura. example: source_of_funds element_type: type: string description: >- Tipo de pergunta. A API aceita estes valores em minúsculas e seus equivalentes em maiú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: >- Rótulo da pergunta por código de idioma, por exemplo `{ "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: >- Use para `dropdown`, `single_choice` e `multiple_choice`. Se `value` for omitido, a API gera um a partir do rótulo da opção. items: type: object required: - label properties: value: type: string label: type: object additionalProperties: type: string max_files: type: integer minimum: 1 maximum: 5 description: Use com `file_upload` ou `image`. validation: type: object nullable: true description: >- Validação de formato opcional para `short_text`, `long_text` ou `number`. É aplicada enquanto o usuário preenche o campo (ele não pode avançar até que a validação seja aprovada) e verificada novamente pela API no envio. properties: pattern: type: string description: >- Expressão regular (subconjunto do ECMA-262) à qual o valor deve corresponder por completo. Para `short_text` e `long_text`. Não adicione as âncoras ^/$; o valor inteiro é verificado. min_length: type: integer minimum: 0 description: Número mínimo de caracteres. Para `short_text` e `long_text`. max_length: type: integer minimum: 0 description: Número máximo de caracteres. Para `short_text` e `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: >- Mensagem traduzida exibida quando a validação falha, indexada pelo código do idioma. additionalProperties: type: string securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.