Update basic attributes, fields, locale, timezone, folder placement or theme. All body attributes are optional; only the provided ones are updated.
fields array is reconciledWhen a fields array is provided, it replaces the form’s current field list.
For each entry the server uses the optional api_code to decide intent:
api_code omitted → add a new field; the server auto-generates an api_code
(e.g. field_3).api_code matches an existing field → update that field in place.api_code is absent from the request → that field is removed.The same rule applies recursively to every api_code-bearing nested object on a
field (most notably choices on choice-type fields, and statements / dimensions /
levels on matrix, likert and cascade): omit the api_code
to add, supply it to update, and skip it to delete.
Required scope: form:write.
Documentation Index
Fetch the complete documentation index at: https://formhug.ai/docs/llms.txt
Use this file to discover all available pages before exploring further.
Personal Access Token prefixed with fh_. Sent as Authorization: Bearer fh_xxx.
The scope required by each endpoint is listed in that endpoint's description.
Form token
All attributes are optional; only the provided ones are updated.
New form name.
New form description.
Form locale, e.g. en, zh-CN, it.
IANA timezone name used by the form when interpreting times.
Replaces the form's field list. See the "How the fields array is reconciled" section above for the add / update / delete semantics, and the Form Field schema for the parameters accepted per field type.
A field definition supplied on form create / update. Every field accepts the shared keys
(label, api_code, notes, private, required, ...) plus a set of type-specific keys
determined by its type — see the per-type sections below.
Auto-generate a header image and matching palette. Provide either header_image_url or header_image_keywords.
Target folder token; empty string moves the form to the desktop (root).
Original folder token; used for cross-folder move authorization.
Updated