Date and time when the form schema was created.
Deprecated. Use deletedFormFields instead.
Form fields that were soft deleted.
Message displayed to visitors when the form is disabled. This allows you to inform submitters why the form isn't available.
See the child properties of this field in the Ricos Document reference.
Whether the form is effectively active — true only when the user has not disabled the form
and no system service has placed an activationBlock on it.
Writing enabled: true records the user's intent to activate the form, but the value read
back may still be false if activationBlock is present (for example, a plan restriction is in
effect). Once the block is lifted the form becomes active automatically without any additional
write.
Default: true
Data extensions for storing additional custom properties.
Form fields that define the input elements and their validation rules.
The order of this array isn't the order the fields are displayed in. Display order comes from steps, where each layout item positions a field by row and column. Don't render fields in array order.
For a detailed explanation of how to compose each kind of field, including which identifier, inputType, and componentType values to combine, see About Form Fields.
Business logic rules that can modify form behavior based on user input or other conditions. These rules can show/hide fields, change validation, or trigger actions.
Form schema ID.
Submission limits that can automatically disable the form when reached.
Media folder ID for storing uploaded files from form submissions.
Display name of the form schema.
Names are unique in a namespace. If the name you pass is already taken, the request still succeeds, and the form schema is stored under a numbered variation of that name instead of returning an error. Read name from the response to learn the name the schema was actually saved under.
Unique identifier for the app that owns this form schema.
For example, wix.form_app.form for Wix Forms.
See a list of namespaces for apps made by Wix section.
Quiz configuration for a scored form. Set this when the form is a quiz whose answers are scored: it holds the passing criteria (score threshold in points or percentage), how the result is shown on the confirmation page (score, pass/fail status, or both), and the pass/fail messages. Absent on non-quiz forms.
Configuration for how required field indicators are displayed to the submitter.
Revision number, which increments by 1 each time the form schema is updated. To prevent conflicting changes, the current revision must be passed when updating the form schema.
Form rules, can be applied to layout and items properties.
Layout configuration that defines how form fields are organized across multiple steps. Each step represents a page of the form.
Every field in formFields, including the submit button, must be placed by a layout item whose fieldId matches the field's id. A field that isn't placed still stores submitted values, but the Wix dashboard renders it, and the submissions made against it, as empty.
Use a single step unless the form is split across pages.
Configuration for actions taken after a form is successfully submitted.
Tag IDs collections associated with the current entity.
Date and time when the form schema was last updated.