Перейти к документации
API

Обновление формы

Частичное обновление. `document` заменяет черновик целиком, а активная форма продолжает показывать свою опубликованную копию, пока вы не опубликуете изменения. `settings` объединяется поле за полем и вступает в силу сразу.

PATCH/forms/{id}

Выполняет настоящий запрос в вашем рабочем пространстве.

PATCH /forms/{id}

Частичное обновление. document заменяет черновик целиком, а активная форма продолжает показывать свою опубликованную копию, пока вы не опубликуете изменения. settings объединяется поле за полем и вступает в силу сразу.

Пример

Требуется forms:write, а также emails:send, если вызов включает двойное подтверждение, указывает отправителя или меняет письмо с подтверждением. Передайте прочитанный updatedAt как expectedUpdatedAt: если кто-то успел сохранить форму в промежутке, ваше изменение будет отклонено, а не записано поверх чужого.

curl
curl -X PATCH "$OE/forms/frm_3b9d2e7a1c4f80d56e2a9b14" -H "$AUTH" -H 'content-type: application/json' -d '{  "settings": { "successAction": "redirect", "redirectUrl": "https://acme.com/thanks" },  "expectedUpdatedAt": "2026-09-12T08:00:00.000Z"}'
Ответ
{  "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"}

Устаревший expectedUpdatedAt даёт 409 version_conflict, и ничего не записывается. Прочитайте форму заново и повторите изменение.

Значение неверного вида, например цвет не в формате #rrggbb или redirectUrl, который не является URL со схемой http или https, даёт 422 invalid_parameter, а для ключа, который тело не принимает, unknown_parameter. Правило, которое документ или настройки нарушают в совокупности, даёт 422 invalid_form. Обе ошибки называют поле в param, например document.fields.2.key или settings.redirectUrl.

Чтобы изменить одно поле документа, прочитайте форму, измените его и отправьте весь document обратно.

Ваши входящие,
на ваших условиях.

Почтовая инфраструктура для бизнеса, ИИ, агентов и личной почты. Создана для масштаба, приватности и контроля. Всё, что должно было быть в почте с первого дня.