Update form settings
Update one or more supported settings. Omitted settings are kept.
PATCH
/api/v1/forms/{formId}/settingsAuthorization
Authorization required string · header
Bearer <token> with an account API key that has the forms:write scope. Path parameters
formId required string
Request body
application/json
Send at least one field. See FormSettings and the REST validation rules.
enableExpirationDateboolean
enableTimeLimitboolean
filterSpamboolean
generatePseudonymIdboolean
enableQuotaLimitboolean
enableIpLimitboolean
displayIpAddressboolean
enableProgressboolean
enableQuestionListboolean
enableNavigationArrowsboolean
openLinksInNewTabboolean
enableClosedMessageboolean
allowArchiveboolean
requirePasswordboolean
password here if the form has no saved password. enableEmailNotificationboolean
redirectOnCompletionboolean
enabledAtinteger ≥ 0
closedAtinteger ≥ 0
timeLimitinteger ≥ 0
ipLimitTimeinteger ≥ 0
redirectDelayinteger ≥ 0
quotaLimitinteger ≥ 1
ipLimitCountinteger ≥ 1
expirationTimeZonestring
localestring
en. closedFormTitlestring
closedFormDescriptionstring
metaTitlestring
metaDescriptionstring
redirectUrlstring
metaOGImageUrlstring
passwordstring
Response
200 · application/json
Source model: FormModel.
| Field | Type | Description |
|---|---|---|
id | string | ID returned by the operation. |
updated | boolean | Whether the update succeeded. |