跳转到主要内容
PATCH
cURL
对部分更新请使用 PATCH。若要重命名问卷,只需发送 title 或 description。
若要更新问题,请发送完整的目标 form_elements 数组。这会替换之前的问题列表。如果仍需显示某些现有问题,请将其保留在数组中。
v3 API 仅支持简单的线性问卷。它会拒绝 graph、branches、next 以及条件规则。 响应中包含 questionnaire_id。更新 published 状态的问卷时,API 可能会创建新版本。请保存返回的 questionnaire_id,并在工作流中使用它,而不要假定 URL 中的 id 仍是最新版本。

授权

x-api-key
string
header
必填

您的应用 API 密钥,可在 Business Console 的“开发者 -> API 密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域:针对每个资源设为无权限、只读或读写,限定于特定工作流或已通过的会话、限定于 IP 地址列表,以及设置到期日期。401 表示密钥错误、已撤销或已过期;403 表示未发送密钥、密钥无权访问该资源或操作,或请求来自其 IP 列表之外的地址;在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF URL 将为 null;没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅 https://docs.didit.me/console/api-keys。

路径参数

questionnaire_uuid
string<uuid>
必填

要更新的问卷版本 UUID。

请求体

application/json

更新问卷元数据或替换完整的线性 form_elements 列表。

title
string
description
string | null
languages
string[]
default_language
string
is_active
boolean
status
enum<string>
可用选项:
draft,
published
form_elements
object[]

如果提供,将替换完整的线性问题列表。

Minimum array length: 1

响应

问卷已更新。body 是生成版本的最新状态 — 就地更新的版本,或者当您在已发布行上发送 status: "published" 时新创建的已发布版本(在该情况下,questionnaire_id 和 version 与您打补丁的版本不同)。响应中的 questionnaire_id 是每个版本的 UUID;如果您需要稳定的组标识符,请使用 questionnaire_group_id。

从 GET、POST(创建)和 PATCH(更新)endpoint 返回的完整问卷详情。

questionnaire_id
string<uuid>

问卷的唯一标识符。在工作流中引用该问卷或在后续更新/删除请求中使用此 ID。

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

包含 start_node 和 nodes 映射的图谱结构。

sections
object[]

分组到各节中的问卷内容(源自图谱)。

questionnaire_group_id
string<uuid>

用于将同一问卷的所有版本分组的稳定标识符。

version
integer
status
enum<string>
可用选项:
draft,
published
published_at
string<date-time> | null
is_editable
boolean

当问卷仍可就地编辑(草稿版本)时为 true。

最后修改于 2026年11月7日