Atualizar um formulário
Uma atualização parcial. `document` substitui o rascunho por inteiro, e um formulário ativo continua a mostrar a sua versão publicada até publicar. `settings` é fundido campo a campo e tem efeito de imediato.
Executa a chamada real no seu espaço de trabalho.
PATCH /forms/{id}
Uma atualização parcial. document substitui o rascunho por inteiro, e um formulário ativo continua a mostrar a sua versão publicada até publicar. settings é fundido campo a campo e tem efeito de imediato.
Exemplo
Requer forms:write, e também emails:send quando ativa a dupla confirmação, indica um remetente ou altera o email de confirmação. Envie o updatedAt que leu como expectedUpdatedAt: se alguém tiver guardado o formulário entretanto, a sua alteração é recusada em vez de se sobrepor à dessa pessoa.
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"}Um expectedUpdatedAt desatualizado dá um 409 version_conflict, e nada é escrito. Leia o formulário de novo e refaça a alteração.
Um valor com a forma errada, como uma cor que não seja #rrggbb ou um redirectUrl que não seja um URL http ou https, dá um 422 invalid_parameter, ou unknown_parameter para uma chave que o corpo não aceita. Uma regra que o documento ou as definições violem em conjunto dá um 422 invalid_form. Ambos indicam o campo em param, como document.fields.2.key ou settings.redirectUrl.
Para alterar um campo do documento, leia o formulário, altere-o e envie de volta o document completo.
