メインコンテンツへスキップ
PATCH
cURL
部分的な更新にはPATCHを使用します。アンケートの名前を変更する場合は、titleまたはdescriptionのみを送信します。
質問を更新する場合は、更新後のform_elements配列全体を送信します。この配列は以前の質問リストを置き換えます。引き続き表示したい既存の質問はすべて含めてください。
v3 APIはシンプルな直線型のアンケートのみをサポートします。graph、branches、nextおよび条件付きルールは拒否されます。 レスポンスにはquestionnaire_idが含まれます。publishedのアンケートを更新すると、APIが新しいバージョンを作成する場合があります。URL内のIDが最新バージョンのままであると想定せず、返されたquestionnaire_idを取得してワークフローで使用してください。

承認

x-api-key
string
header
必須

お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンが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

レスポンス

アンケートが更新されました。本文は、結果として得られたバージョンの最新の状態です。つまり、その場で更新されたバージョン、または公開済みの行にstatus: "published"を送信した場合は新たに作成された公開バージョンです(この場合、questionnaire_idとversionはパッチを適用したものと異なります)。レスポンスのquestionnaire_idはバージョンごとのUUIDです。安定したグループ識別子が必要な場合はquestionnaire_group_idを使用してください。

GET、POST(作成)、PATCH(更新)の各エンドポイントから返されるアンケートの完全な詳細。

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月1日