Form Object


Properties
idstringRead-onlyformat GUID

Form schema ID.


formFieldsArray <Field>maxItems 500

Form fields that define the input elements and their validation rules.


stepsArray <Step>maxItems 100

Layout configuration that defines how form fields are organized across multiple steps. Each step represents a page of the form.


rulesArray <FormRule>deprecated - use formRules insteadmaxItems 100

Form rules, can be applied to layout and items properties.


revisionstringRead-onlyformat int64

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.


createdDatestringRead-onlyformat date-time

Date and time when the form schema was created.


updatedDatestringRead-onlyformat date-time

Date and time when the form schema was last updated.


deletedFieldsArray <FormField>Read-onlymaxItems 150

Fields which were soft deleted.


deletedFieldsV2Array <FormFieldV2>Read-onlymaxItems 150

List of form fields that represent input elements.


deletedFormFieldsArray <Field>Read-onlymaxItems 150

Form fields that were soft deleted.


extendedFieldsExtendedFields

Data extensions for storing additional custom properties.


namespacestringminLength 10maxLength 50immutable

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.


mediaFolderIdstringRead-onlymaxLength 100

Media folder ID for storing uploaded files from form submissions.


limitationRuleLimitationRule

Submission limits that can automatically disable the form when reached.


spamFilterProtectionLevelstring

Level of spam protection applied to form submissions.

Default: ADVANCED


requiredIndicatorPropertiesRequiredIndicatorProperties

Configuration for how required field indicators are displayed to the submitter.


submitSettingsSubmitSettings

Configuration for actions taken after a form is successfully submitted.


disabledFormMessageDisabledFormMessage

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.


enabledboolean

Whether the form schema is enabled.

Default: true


namestringmaxLength 200

Display name of the form schema.


formRulesArray <Rule>maxItems 100

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.

Did this help?