Update a form

Updates an existing form. This is a partial update — only the properties
present in the request body are changed; omitted properties keep their current value.

fields

Providing fields replaces the form's entire field set (same resolution rules as
POST /newsletter/{newsletterId}/form: email is auto-prepended for subscribe/order
forms, at least one field is required for update forms). Omit fields entirely to leave
the current fields untouched. To add or remove individual fields without replacing the
whole set, use POST .../fields / DELETE .../field/{fieldName} instead.

Order-form fields

shippingMethodIds, orderType, and products are a group for order forms
(method: "order"): if you provide one of them, provide all three — together they
replace the form's shipping methods, order type, and product list entirely.

method

The form's method (subscribe / update / order) cannot be changed after
creation. Sending a method value that differs from the form's current method
returns a validation error.

Limitations

  • Only forms belonging to the authenticated account are accessible.
  • Only non-archived forms can be updated.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Form ID within the list

Body Params

Partial update — every property is optional. Omitted properties keep their current
value. method cannot be changed and is rejected with a validation error if it differs
from the form's current method.

string

New form name (displayed in the admin interface)

string
enum

Must match the form's current method if provided — included only to make an
accidental method change fail loudly rather than silently.

Allowed:
string

New heading text displayed at the top of the rendered form.

string

New introductory text shown below the form title.

string

New full HTML content for the thank-you page.

string

New free-text description of the form (visible in the admin interface).

integer

New form template ID to apply during HTML regeneration.

string

New label text on the submit button.

string

Replaces the form's custom HTML/CSS/JS code. <style> blocks and
<link rel="stylesheet"> tags are automatically moved into the generated page's
<head>; everything else (typically <script> blocks) is placed in the page footer.
Pass an empty string ("") to remove the existing custom code.

integer
enum
  • 0 — subscriber added immediately
  • 2 — double opt-in confirmation e-mail sent first
Allowed:
fields
array of objects

Replaces the form's entire field set. Omit this property entirely to leave the
current fields untouched — an empty array is treated the same as providing fields
(see the field resolution rules on POST /newsletter/{newsletterId}/form).

fields
shippingMethodIds
array of integers

Replaces the order form's shipping methods. Must be provided together with
orderType and products. Only applicable to forms with method: "order".

shippingMethodIds
integer
enum

Replaces the order form's order type. Must be provided together with
shippingMethodIds and products.

Allowed:
products
array of objects

Replaces the order form's entire product list. Must be provided together with
shippingMethodIds and orderType.

products
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json