API
フォームを作成する
`document` から、`starter` から、またはどちらも送らない場合はメールアドレスのフィールドが 1 つだけのフォームから下書きを作成し、フォーム全体を返します。同じ呼び出しで公開するには `publish: true` を送ってください。
POST/forms
実際の呼び出しをワークスペースに対して実行します。
POST /forms
document から、starter から、またはどちらも送らない場合はメールアドレスのフィールドが 1 つだけのフォームから下書きを作成し、フォーム全体を返します。同じ呼び出しで公開するには publish: true を送ってください。
例
forms:write が必要で、ダブルオプトインをオンにする場合、送信元を指定する場合、確認メールを設定する場合は emails:send も必要です。
curl -X POST "$OE/forms" -H "$AUTH" -H 'content-type: application/json' -d '{ "name": "Newsletter sign-up", "starter": "newsletter", "settings": { "audienceIds": ["aud_4c1b8e2a7d9f05c36b4e8a71"], "doubleOptIn": true, "senderAddress": "[email protected]" }, "publish": true}'{ "object": "form", "id": "frm_3b9d2e7a1c4f80d56e2a9b14", "name": "Newsletter sign-up", "description": null, "status": "live", "url": "https://openemail.uk/form/frm_3b9d2e7a1c4f80d56e2a9b14", "subscribeUrl": "https://api.openemail.uk/subscribe/frm_3b9d2e7a1c4f80d56e2a9b14", "audienceIds": ["aud_4c1b8e2a7d9f05c36b4e8a71"], "doubleOptIn": true, "hasUnpublishedChanges": true, "document": { "fields": [ { "id": "fld_k2m8q4w9z1x7", "type": "email", "key": "email", "label": "Email", "placeholder": "[email protected]", "help": null, "required": true, "defaultValue": null, "options": [], "mapsTo": "email", "width": "full", "minLength": null, "maxLength": null, "min": null, "max": null } ], "copy": { "title": "Join our list", "description": "News from us, about once a month.", "submitLabel": "Subscribe", "successTitle": "You are on the list", "successMessage": "Thanks for signing up.", "pendingTitle": "Check your inbox", "pendingMessage": "Open the email we sent and confirm to finish.", "closedTitle": "This form is closed", "closedMessage": "It is not taking new sign-ups right now.", "footer": null }, "style": { "accent": "#18181b", "background": "#f4f4f5", "surface": "#ffffff", "text": "#18181b", "font": "system", "radius": "md", "width": "normal", "layout": "card", "align": "left", "logoUrl": null } }, "publishedDocument": { "fields": ["…"], "copy": { "title": "Join the list" }, "style": { "accent": "#18181b" } }, "settings": { "audienceIds": ["aud_4c1b8e2a7d9f05c36b4e8a71"], "doubleOptIn": true, "senderAddress": "[email protected]", "confirmSubject": "Please confirm your subscription", "confirmMessage": "Confirm your email address to start getting our messages.", "confirmButton": "Confirm my subscription", "successAction": "message", "redirectUrl": null, "notifyAddresses": ["[email protected]"] }, "audiences": [{ "id": "aud_4c1b8e2a7d9f05c36b4e8a71", "name": "Newsletter", "builtin": false }], "senderIssue": null, "senderProblem": null, "stats": { "views": 1840, "submissions": 212, "added": 198, "pending": 14, "lastSubmittedAt": "2026-09-30T16:42:11.000Z" }, "publishedAt": "2026-09-12T08:00:00.000Z", "createdAt": "2026-09-10T14:20:00.000Z", "updatedAt": "2026-09-12T08:00:00.000Z"}settings には設定の任意の一部を渡せ、残りは既定値のままです。
settings.audienceIds と audiences フィールドに含まれるオーディエンスは、すべてこのワークスペースでアクセスできるものでなければなりません。そうでなければ 404 audience_not_found が返ります。
ダブルオプトインのフォームには、送信元として使えるアドレスである settings.senderAddress が必要です。送信できない送信元は 422 form_sender_refused で拒否されます。
publish が true でフォームを公開できない場合は、何も作成されません。
1 つのワークスペースが持てるフォームは、既定で 100 件です。それを超えると 422 workspace_limit_reached で拒否されます。
