ドキュメント本文へスキップ
API

フォームのデザインを変更

デザイナーがフォームの下書きに文章の指示を適用し、ほかはそのまま残します。アプリのフォームビルダーにある「AIに依頼」と同じです。

POST/forms/{id}/redesign

実際の呼び出しをワークスペースに対して実行します。

POST /forms/{id}/redesign

デザイナーがフォームの下書きに文章の指示を適用し、ほかはそのまま残します。アプリのフォームビルダーにある「AIに依頼」と同じです。

例

forms:write が必要です。instructions には変更内容を最大 4,000 文字で書きます。フィールドの追加、削除、並べ替え、文面の書き直しや翻訳、色やフォントの変更などです。

curl
curl -X POST "$OE/forms/frm_3b9d2e7a1c4f80d56e2a9b14/redesign" -H "$AUTH" -H 'content-type: application/json' -d '{  "instructions": "Add a required company field after the name, and make the button say Join.",  "expectedUpdatedAt": "2026-09-30T09:12:44.000Z"}'
レスポンス
{  "object": "form",  "id": "frm_3b9d2e7a1c4f80d56e2a9b14",  "name": "Newsletter sign-up",  "status": "live",  "hasUnpublishedChanges": true,  "design": {    "notes": ["Added a required company field after the name.", "Changed the button to say Join."]  }}

変更は下書きに保存されるため、公開中のフォームは POST /forms/{id}/publish まで公開版を表示し続けます。

読み取った updatedAt を expectedUpdatedAt として送ると、その間に行われた保存は 409 version_conflict で拒否されます。デザイナーの作業中に行われた保存も同じく拒否され、何も書き込まれません。

AI アクションを 1 回使い、最大 30 秒ほどかかり、フォームのデザインと同じ理由で失敗します。

リファレンス