Saltar para o conteúdo principal
PATCH
cURL
Use PATCH para atualizações parciais. Para renomear um questionário, envie apenas title ou description.
Para atualizar as perguntas, envie o array form_elements completo pretendido. Este substitui a lista de perguntas anterior. Inclua as perguntas existentes que ainda pretende apresentar.
A API v3 suporta apenas questionários lineares simples. Rejeita graph, branches, next e regras condicionais. A resposta inclui questionnaire_id. Quando atualiza um questionário published, a API pode criar uma nova versão. Guarde o questionnaire_id devolvido e use-o nos fluxos, em vez de presumir que o id no URL ainda é o da versão mais recente.

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, 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á incorreta, 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 o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de caminho

questionnaire_uuid
string<uuid>
obrigatório

UUID por versão do questionário a atualizar.

Corpo

application/json

Atualizar os metadados do questionário ou substituir a lista linear completa de form_elements.

title
string
description
string | null
languages
string[]
default_language
string
is_active
boolean
status
enum<string>
Opções disponíveis:
draft,
published
form_elements
object[]

Se fornecido, substitui toda a lista linear de perguntas.

Minimum array length: 1

Resposta

Questionário atualizado. O corpo é o estado mais recente da versão resultante — a versão atualizada diretamente, ou a versão publicada recém-criada quando enviou status: "published" num registo publicado (nesse caso questionnaire_id e version diferem daqueles que modificou). O questionnaire_id na resposta é o UUID por versão; utilize questionnaire_group_id se precisar do identificador estável do grupo.

Detalhe completo do questionário retornado pelos endpoints GET, POST (criar) e PATCH (atualizar).

questionnaire_id
string<uuid>

Identificador único do questionário. Utilize este id ao referenciar o questionário a partir de um fluxo ou em pedidos subsequentes de atualização/eliminação.

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

Estrutura em grafo com start_node e mapa de nós.

sections
object[]

Conteúdo do questionário agrupado em secções (derivado do grafo).

questionnaire_group_id
string<uuid>

Identificador estável que agrupa todas as versões do mesmo questionário.

version
integer
status
enum<string>
Opções disponíveis:
draft,
published
published_at
string<date-time> | null
is_editable
boolean

True quando o questionário ainda pode ser editado no local (versões de rascunho).

Última modificação em 7 de novembro de 2026