Saltar al contingut principal
PATCH
cURL
Fes servir PATCH per a les actualitzacions parcials. Per canviar el nom d’un qüestionari, envia només title o description.
Per actualitzar les preguntes, envia la matriu form_elements completa que vulguis. Això substitueix la llista de preguntes anterior. Mantén les preguntes existents que encara vulguis mostrar.
L’API v3 només admet qüestionaris lineals simples. Rebutja graph, branches, next i les regles condicionals. La resposta inclou questionnaire_id. Quan actualitzes un qüestionari published, l’API pot crear una nova versió. Captura el questionnaire_id retornat i fes-lo servir als fluxos de treball en lloc de suposar que l’id de la URL encara és la versió més recent.

Autoritzacions

x-api-key
string
header
requerit

La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.

Paràmetres de ruta

questionnaire_uuid
string<uuid>
requerit

UUID per versió del qüestionari que s'actualitzarà.

Cos

application/json

Actualitza les metadades del qüestionari o substitueix la llista lineal completa de form_elements.

title
string
description
string | null
languages
string[]
default_language
string
is_active
boolean
status
enum<string>
Opcions disponibles:
draft,
published
form_elements
object[]

Si es proporciona, això substitueix la llista lineal completa de preguntes.

Minimum array length: 1

Resposta

Qüestionari actualitzat. El cos és l'últim estat de la versió resultant — la versió actualitzada in situ, o la versió publicada creada de nou quan has enviat status: "published" en una fila publicada (en aquest cas questionnaire_id i version difereixen dels que has modificat). El questionnaire_id de la resposta és l'UUID per versió; utilitza questionnaire_group_id si necessites l'identificador de grup estable.

Detall complet del qüestionari retornat des dels endpoints GET, POST (creació) i PATCH (actualització).

questionnaire_id
string<uuid>

Identificador únic del qüestionari. Utilitza aquest id en fer referència al qüestionari des d'un flux de treball o en sol·licituds posteriors d'actualització o supressió.

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

Estructura del graf amb start_node i mapa de nodes.

sections
object[]

Contingut del qüestionari agrupat en seccions (derivat del graf).

questionnaire_group_id
string<uuid>

Identificador estable que agrupa totes les versions del mateix qüestionari.

version
integer
status
enum<string>
Opcions disponibles:
draft,
published
published_at
string<date-time> | null
is_editable
boolean

Cert quan el qüestionari encara es pot editar in situ (versions en esborrany).

Darrera modificació el 7 de novembre del 2026