Form Object


Properties
createdDatestringRead-onlyformat date-time

Date and time when the form schema was created.


deletedFieldsArray <FormField>Read-onlymaxItems 150

Fields which were soft deleted.


deletedFormFieldsArray <Field>Read-onlymaxItems 150

Form fields that were soft deleted.


disabledFormMessageRichContent

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


extendedFieldsExtendedFields

Data extensions for storing additional custom properties.


formFieldsArray <Field>maxItems 500

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


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.


idstringRead-onlyformat GUID

Form schema ID.


limitationRuleLimitationRule

Submission limits that can automatically disable the form when reached.


mediaFolderIdstringRead-onlymaxLength 100

Media folder ID for storing uploaded files from form submissions.


namestringmaxLength 200

Display name of the form schema.


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.


requiredIndicatorPropertiesRequiredIndicatorProperties

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


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.


rulesArray <FormRule>deprecated - use formRules insteadmaxItems 100

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


spamFilterProtectionLevelstring

Level of spam protection applied to form submissions.

Default: ADVANCED


stepsArray <Step>maxItems 100

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


submitSettingsSubmitSettings

Configuration for actions taken after a form is successfully submitted.


tagsTags

Tag IDs collections associated with the current entity.


updatedDatestringRead-onlyformat date-time

Date and time when the form schema was last updated.

Did this help?