Pause or resume a form

Pause a form without deleting it, or resume a paused form. The state is stored as the boolean options.paused on the form; a form without it is not paused.

Only options.paused changes: the form keeps its id and embed code, and only this endpoint changes it: PUT /forms/{id} keeps the stored value whatever its options say about paused. The response is the form exactly as GET /forms/{id} returns it, read after the change is saved.

While the forms-pause feature is enabled for the account, new submissions to a paused form are refused, and visitors see a paused message in place of its fields: the account's own options.paused_message, with an optional button from options.paused_link_text and options.paused_link_url, or a default message when none is set. The form's own link always shows it. An inline form's embed shows it only when the form has its own message or button, and renders nothing otherwise; pop-up layouts' embeds render nothing. Those three options are saved with POST /forms and PUT /forms/{id}, which trim them, add https:// to an address without one, and answer 422 naming the option when the message or button text is too long, the button has only one of its two values, or the address isn't an http(s) web address. With the feature disabled, every form behaves as active whatever options.paused says.

Requires the same permission as editing a form. While the forms-pause feature is disabled for the account, this endpoint returns 404.

Path Params
int32
required

ID of the form to pause or resume

Body Params
boolean
required

true to pause the form, false to resume it

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json