Update form settings

Update one or more supported settings. Omitted settings are kept.


PATCH/api/v1/forms/{formId}/settings

Authorization

Authorization required string · header
Send Bearer <token> with an account API key that has the forms:write scope.

Path parameters

formId required string
Form ID. See FormModel.

Request body

application/json

Send at least one field. See FormSettings and the REST validation rules.

enableExpirationDateboolean
Enable the form opening and closing schedule.
enableTimeLimitboolean
Enable the time limit for completing the form.
filterSpamboolean
Enable spam filtering.
generatePseudonymIdboolean
Assign a pseudonym ID to submissions.
enableQuotaLimitboolean
Enable the response quota.
enableIpLimitboolean
Enable submission limits per IP address.
displayIpAddressboolean
Make submission IP addresses visible where supported.
enableProgressboolean
Show respondent progress.
enableQuestionListboolean
Show the question list.
enableNavigationArrowsboolean
Show navigation arrows.
openLinksInNewTabboolean
Open links in a new tab.
enableClosedMessageboolean
Show a custom message for a closed form.
allowArchiveboolean
Allow archiving submissions.
requirePasswordboolean
Require a password. Supply password here if the form has no saved password.
enableEmailNotificationboolean
Enable email notifications.
redirectOnCompletionboolean
Redirect the respondent after completion.
enabledAtinteger ≥ 0
Opening time as Unix seconds.
closedAtinteger ≥ 0
Closing time as Unix seconds.
timeLimitinteger ≥ 0
Completion time limit in seconds.
ipLimitTimeinteger ≥ 0
Per-IP limit window in seconds.
redirectDelayinteger ≥ 0
Delay before redirecting on completion.
quotaLimitinteger ≥ 1
Maximum number of responses.
ipLimitCountinteger ≥ 1
Maximum submissions per IP in the configured window.
expirationTimeZonestring
Time zone for the opening and closing schedule.
localestring
Form interface locale, for example en.
closedFormTitlestring
Heading for the closed form.
closedFormDescriptionstring
Description for the closed form.
metaTitlestring
Page title used in metadata.
metaDescriptionstring
Page description used in metadata.
redirectUrlstring
Completion redirect. Use an HTTP or HTTPS URL.
metaOGImageUrlstring
Social preview image. Use an HTTP or HTTPS URL.
passwordstring
Form password, 1–72 characters.

Response

200 · application/json

Source model: FormModel.

FieldTypeDescription
idstringID returned by the operation.
updatedbooleanWhether the update succeeded.