> To build or manage a Wix site with an AI agent, follow https://www.wix.com/headless/skill.md
> It builds a new Wix site or puts your own site online, from a prompt, and keeps changing it afterwards. The pages are code in any web technology, and Wix runs the backend.
> It works through the Wix plugin (the Wix MCP and the Wix skills), the Wix CLI or no Wix login, and puts the site live on Wix hosting or on another host.
> Business features include a store, bookings, events and tickets, a restaurant, a blog, forms, members and many more.
> Read the Wix skills online at https://www.wix.com/skills
> 
> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - If a reference page seems to be missing its schema (parameters, return types, or type definitions), append `?schema=true` to its `.md` URL (e.g. `https://dev.wix.com/docs/contexts/contexts/stores/category-info/use-category-info-context.md?schema=true`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# Resource: Form Schemas

# Type: Form Object

# Link: https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/form-object.md

## Schema:

```json
 Type: Form Object | type: Form
       - name: id  | type: string | description: Form schema ID.
           - name: value  | type: string | description: 
       - name: formFields  | type: Array<Field> | description: 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](https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/about-form-fields.md).
           - name: id  | type: string | description: Field ID.  The ID is stored in lowercase. Because the form's layout references each field by this ID, pass a lowercase GUID so that `id` and the layout's `fieldId` still match after the form schema is stored. IDs must be unique in the form.
           - name: hidden  | type: boolean | description: Whether the field is hidden from submitters.  Default: `false`
           - name: identifier  | type: string | description: Identification for the field, describing its purpose. For example, `TEXT_INPUT` or `CONTACTS_EMAIL`.  Set this to the known value for the kind of field you're creating. Wix accepts an unrecognized value, such as a custom string or a GUID: the request succeeds, and Wix stores the field, returns it in `formFields`, and accepts its submissions. But Wix apps use `identifier` to recognize a field, so the Wix Forms editor doesn't render it, and the Wix user can't see or edit that field. A form whose fields all carry unrecognized identifiers opens empty in the editor. Always map a field onto a known identifier, and set its display name with the component's label.  Several fields share a general-purpose `componentType`, so `identifier` is often the only value that distinguishes them. For example, both a short answer field and a long answer field use the `TEXT_INPUT` component, and are told apart by their `TEXT_INPUT` and `TEXT_AREA` identifiers.  For the full list of known values, see [About Form Fields](https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/about-form-fields.md).
           - name: fieldType  | type: string | description: Field type.  `INPUT` fields collect data from submitters and are configured in `inputOptions`. `DISPLAY` fields show information without collecting data and are configured in `displayOptions`.
               enum: UNKNOWN_FIELD_TYPE, INPUT, DISPLAY
           - ONE-OF:
               - name: inputOptions  | type: InputField | description: Configuration for input fields that collect user data.
                   - name: target  | type: string | description: Human readable identifier used to reference a field, used as the key under which the field's value is stored in a submission. For example, `"address"`.  Required for input fields. Must be unique within the form (comparison is case-sensitive).  Naming rules: - Must start with an ASCII letter (`a`-`z` or `A`-`Z`). - May contain ASCII letters, digits, and underscores (`_`). No spaces, hyphens, or non-ASCII characters. - Consecutive underscores (`__`) are not allowed. - Casing is not enforced, so `camelCase`, `snake_case`, and `PascalCase` are all valid.  Can be set once.
                   - name: pii  | type: boolean | description: Whether this field contains Personally Identifiable Information (PII).  PII fields are automatically encrypted when stored.  Default: `false`
                   - name: required  | type: boolean | description: Whether the field is required for form submission.  Set this on `inputOptions`, alongside `target` and `inputType`. A `required` placed inside a validation object, such as `stringOptions.validation`, isn't part of the schema and has no effect.  Default: `false`
                   - name: inputType  | type: string | description: Type of the input field that determines what kind of data it collects.  `inputType` selects which options object applies. For example, `STRING` is configured in `stringOptions`, and `PAYMENT` in `paymentOptions`. That options object then sets a `componentType`, which selects the UI component and its own nested settings object.  For which combinations produce which field, see [About Form Fields](https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/about-form-fields.md).
                   - name: contactMapping  | type: FormFieldContactInfo | description: Mapping configuration for automatically saving field values to contact properties.  When specified, form submissions automatically create or update contacts with the field data.
                   - name: readOnly  | type: boolean | description: Whether the field is read-only.  Default: `false`
                   - ONE-OF:
                       - name: stringOptions  | type: String | description: String input field settings.
                       - name: numberOptions  | type: Number | description: Number input field settings.
                       - name: booleanOptions  | type: Boolean | description: Boolean input field settings.
                       - name: arrayOptions  | type: Array | description: Array input field settings.
                       - name: objectOptions  | type: Object | description: Object input field settings.
                       - name: wixFileOptions  | type: WixFile | description: File input field settings. Files are uploaded to the [Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager).  > **Note:** File upload and signature fields are premium features. The site must have a Core premium plan or higher. Creating a form schema with one of these fields on a site without a qualifying plan fails.
                       - name: paymentOptions  | type: Payment | description: Payment input field settings.  > **Note:** Payment fields are premium features that also depend on another app. The site must have a Core premium plan or higher, and the Wix eCommerce app must be installed. Creating a form schema with a payment field on a site that doesn't meet both requirements fails.
                       - name: schedulingOptions  | type: Scheduling | description: Scheduling input field settings.  > **Note:** Scheduling fields require the Wix Meetings app to be installed on the site. Creating a form schema with a scheduling field on a site without the app fails.
                       - name: addressOptions  | type: Address | description: Address input field settings.
               - name: displayOptions  | type: DisplayField | description: Configuration for display fields that show information without collecting input.
                   - name: displayFieldType  | type: string | description: Type of display field that determines its appearance and behavior.
                   - ONE-OF:
                       - name: richContentOptions  | type: RichContentOptions | description: Configuration for rich content display fields.
                       - name: pageNavigationOptions  | type: PageNavigationOptions | description: Configuration for page navigation display fields such as navigation or submit buttons.
       - name: steps  | type: Array<Step> | description: 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.
           - name: id  | type: string | description: Step ID.
           - name: name  | type: string | description: Name of the step.
           - name: hidden  | type: boolean | description: Whether the step is hidden.
           - name: layout  | type: FormLayout | description: Layout configuration that defines how form fields are arranged within this step.
               - name: large  | type: BreakPoint | description: Layout configuration for large screen breakpoints (desktop).
               - name: medium  | type: BreakPoint | description: Layout configuration for medium screen breakpoints (tablet).
               - name: small  | type: BreakPoint | description: Layout configuration for small screen breakpoints (mobile).
       - name: rules  | type: Array<FormRule> | description: Form rules, can be applied to layout and items properties.
           - name: id  | type: string | description: Rule ID.
           - name: condition  | type: Struct | description: Condition that determines when this rule's overrides should be applied.
               - name: fields  | type: object | description: 
           - name: overrides  | type: Array<FormOverride> | description: Changes to apply to form elements when the condition evaluates to true.
               - name: entityType  | type: string | description: Type of form element that this override targets.
               - name: entityId  | type: string | description: ID of the form element to modify.
               - name: valueChanges  | type: object | description: Property changes to apply to the form element when the rule condition is met. Each key represents a property path, and the value is the new value to set.
           - name: name  | type: string | description: Name for the rule.
           - name: namespaceRule  | type: boolean | description: Namespace rules are part of business logic of app owning namespace, have limited editing possibilities
               - name: value  | type: boolean | description: 
       - name: revision  | type: string | description: 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.
           - name: value  | type: string | description: 
       - name: createdDate  | type: string | description: Date and time when the form schema was created.
           - name: seconds  | type: string | description: 
           - name: nanos  | type: number | description: 
       - name: updatedDate  | type: string | description: Date and time when the form schema was last updated.
       - name: deletedFields  | type: Array<FormField> | description: Deprecated. Use `deletedFormFields` instead.
           - name: id  | type: string | description: Item ID.
           - name: target  | type: string | description: Definition of a target where the value of field belongs.
           - name: validation  | type: Validation | description: Validation of field output value.
               - name: required  | type: boolean | description: Whether the field is required.
               - ONE-OF:
                   - name: string  | type: StringType | description: Validation of string type.
                   - name: number  | type: NumberType | description: Validation of number type.
                   - name: integer  | type: IntegerType | description: Validation of integer type.
                   - name: boolean  | type: BooleanType | description: Validation of boolean type.
                   - name: array  | type: ArrayType | description: Validation of array type.
                   - name: object  | type: ObjectType | description: Validation of object type.
                   - name: predefined  | type: PredefinedValidation | description: Predefined validation of specific format
           - name: pii  | type: boolean | description: Mark the field as containing personal information. This will encrypt user data when storing it.
           - name: hidden  | type: boolean | description: Whether the field is hidden.
           - name: view  | type: Struct | description: Field view properties.
           - name: dataExtensionsDetails  | type: DataExtensionsDetails | description: Details identifying field, which is extension of other entity
               - name: fqdns  | type: Array<string> | description: FQDNS which can be extended with this field
           - name: readOnly  | type: boolean | description: Whether the field is read only. Default: false
       - name: deletedFormFields  | type: Array<Field> | description: Form fields that were soft deleted.
       - name: extendedFields  | type: ExtendedFields | description: Data extensions for storing additional custom properties.
           - name: namespaces  | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md).
       - name: namespace  | type: string | description: Unique identifier for the app that owns this form schema.  For example, for creating a form visible in the Wix Forms app, use `wix.form_app.form`, the namespace of the Wix Forms app, whose app ID is `225dd912-7dea-4738-8688-4b8c6955ffc2`.  See a list of namespaces for [apps made by Wix](https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/introduction.md#namespaces-of-apps-made-by-wix) section. To retrieve the ID for a Wix app, see [Apps Created By Wix](https://dev.wix.com/docs/rest/articles/get-started/apps-created-by-wix.md).
       - name: mediaFolderId  | type: string | description: Media folder ID for storing uploaded files from form submissions.
       - name: limitationRule  | type: LimitationRule | description: Submission limits that can automatically disable the form when reached.
           - name: maxAllowedSubmissions  | type: number | description: Limitation by submission count, disables form when a set amount of submissions is reached.
               - name: value  | type: number | description: 
           - name: dateTimeDeadline  | type: string | description: Limitation by submission date, disables form when a set date and time is reached.
           - name: submissionLimitPerUser  | type: number | description: Limitation per user submission count, disables form when a set amount of submissions per user is reached.
       - name: spamFilterProtectionLevel  | type: string | description: Level of spam protection applied to form submissions.  Default: `ADVANCED`
           enum: UNKNOWN, NONE, BASIC, ADVANCED
       - name: requiredIndicatorProperties  | type: RequiredIndicatorProperties | description: Configuration for how required field indicators are displayed to the submitter.
           - name: requiredIndicator  | type: string | description: Type of visual indicator used to mark required fields.
               enum: ASTERISK, TEXT, NONE
           - name: requiredIndicatorPlacement  | type: string | description: Position where the required indicator appears relative to the field title.
               enum: AFTER_FIELD_TITLE, BEFORE_FIELD_TITLE
       - name: submitSettings  | type: SubmitSettings | description: Configuration for actions taken after a form is successfully submitted.
           - name: submitSuccessAction  | type: string | description: Action that's triggered after a form is successfully submitted.
               enum: NO_ACTION, THANK_YOU_MESSAGE, REDIRECT, POPUP
           - ONE-OF:
               - name: thankYouMessageOptions  | type: ThankYouMessageOptions | description: Configuration for displaying a thank you message after submission.
                   - name: durationInSeconds  | type: number | description: Duration in seconds before the thank you message automatically disappears. If set to 0, the message remains visible until manually dismissed.
                   - name: richContent  | type: RichContent | description: Rich content message displayed to users after successful form submission.
               - name: redirectOptions  | type: RedirectOptions | description: Configuration for redirecting submitters to a URL after submission.
                   - name: redirectUrl  | type: string | description: URL to which the user should be redirected after successfully submitting the form.
                   - name: target  | type: string | description: How the redirect URL should be opened in the browser.
               - name: popupOptions  | type: PopupOptions | description: Configuration for displaying a popup after submission.
                   - name: popupId  | type: string | description: ID of the site popup to open after successful form submission.
       - name: disabledFormMessage  | type: RichContent | description: Message displayed to visitors when the form is disabled. This allows you to inform submitters why the form isn't available.
           - name: nodes  | type: Array<Node> | description: Node objects representing a rich content document.
               - name: type  | type: string | description: Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format.
               - name: id  | type: string | description: Node ID.
               - name: nodes  | type: Array<Node> | description: A list of child nodes.
               - name: style  | type: NodeStyle | description: Padding and background color styling for the node.
               - ONE-OF:
                   - name: buttonData  | type: ButtonData | description: Data for a button node.
                   - name: codeBlockData  | type: CodeBlockData | description: Data for a code block node.
                   - name: dividerData  | type: DividerData | description: Data for a divider node.
                   - name: fileData  | type: FileData | description: Data for a file node.
                   - name: galleryData  | type: GalleryData | description: Data for a gallery node.
                   - name: gifData  | type: GIFData | description: Data for a GIF node.
                   - name: headingData  | type: HeadingData | description: Data for a heading node.
                   - name: htmlData  | type: HTMLData | description: Data for an embedded HTML node.
                   - name: imageData  | type: ImageData | description: Data for an image node.
                   - name: linkPreviewData  | type: LinkPreviewData | description: Data for a link preview node.
                   - name: mapData  | type: MapData | description: 
                   - name: paragraphData  | type: ParagraphData | description: Data for a paragraph node.
                   - name: pollData  | type: PollData | description: Data for a poll node.
                   - name: textData  | type: TextData | description: Data for a text node. Used to apply decorations to text.
                   - name: appEmbedData  | type: AppEmbedData | description: Data for an app embed node.
                   - name: videoData  | type: VideoData | description: Data for a video node.
                   - name: embedData  | type: EmbedData | description: Data for an oEmbed node.
                   - name: collapsibleListData  | type: CollapsibleListData | description: Data for a collapsible list node.
                   - name: tableData  | type: TableData | description: Data for a table node.
                   - name: tableCellData  | type: TableCellData | description: Data for a table cell node.
                   - name: externalData  | type: Struct | description: Data for a custom external node.
                   - name: audioData  | type: AudioData | description: Data for an audio node.
                   - name: orderedListData  | type: OrderedListData | description: Data for an ordered list node.
                   - name: bulletedListData  | type: BulletedListData | description: Data for a bulleted list node.
                   - name: blockquoteData  | type: BlockquoteData | description: Data for a block quote node.
                   - name: captionData  | type: CaptionData | description: Data for a caption node.
                   - name: layoutData  | type: LayoutData | description: Data for a layout node. Reserved for future use.
                   - name: layoutCellData  | type: LayoutCellData | description: Data for a cell node.
                   - name: shapeData  | type: ShapeData | description: Data for a shape node.
                   - name: cardData  | type: CardData | description: Data for a card node.
                   - name: tocData  | type: TocData | description: Data for a table of contents node.
                   - name: smartBlockData  | type: SmartBlockData | description: Data for a smart block node.
                   - name: smartBlockCellData  | type: SmartBlockCellData | description: Data for a smart block cell node.
                   - name: checkboxListData  | type: CheckboxListData | description: Data for a checkbox list node.
                   - name: listItemData  | type: ListItemNodeData | description: Data for a list item node.
                   - name: slotData  | type: SlotData | description: Data for a slot node.
           - name: metadata  | type: Metadata | description: Object metadata.
               - name: version  | type: number | description: Schema version.
               - name: createdTimestamp  | type: string | description: When the object was created.
               - name: updatedTimestamp  | type: string | description: When the object was most recently updated.
               - name: id  | type: string | description: Object ID.
           - name: documentStyle  | type: DocumentStyle | description: Global styling for header, paragraph, block quote, and code block nodes in the object.
               - name: headerOne  | type: TextNodeStyle | description: Styling for H1 nodes.
               - name: headerTwo  | type: TextNodeStyle | description: Styling for H2 nodes.
               - name: headerThree  | type: TextNodeStyle | description: Styling for H3 nodes.
               - name: headerFour  | type: TextNodeStyle | description: Styling for H4 nodes.
               - name: headerFive  | type: TextNodeStyle | description: Styling for H5 nodes.
               - name: headerSix  | type: TextNodeStyle | description: Styling for H6 nodes.
               - name: paragraph  | type: TextNodeStyle | description: Styling for paragraph nodes.
               - name: blockquote  | type: TextNodeStyle | description: Styling for block quote nodes.
               - name: codeBlock  | type: TextNodeStyle | description: Styling for code block nodes.
       - name: enabled  | type: boolean | description: 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`
       - name: name  | type: string | description: 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.
       - name: formRules  | type: Array<Rule> | description: 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.
           - name: id  | type: string | description: Rule ID.
           - name: expression  | type: ConditionNode | description: Conditional expression that determines when this rule should be applied. The overrides defined in this rule are applied when this expression evaluates to true.  The root of the expression must be an `and` or `or` group. To evaluate a single condition, wrap it in a group with 1 condition.
               - ONE-OF:
                   - name: and  | type: AndCondition | description: Logical AND condition with 1 or more child conditions. All child conditions must be true.
                   - name: or  | type: OrCondition | description: Logical OR condition with 1 or more child conditions. At least 1 child condition must be true.
                   - name: condition  | type: Condition | description: Single condition to evaluate. Not supported as the root of a rule's expression.
           - name: overrides  | type: Array<FormOverride> | description: Form modifications that are applied when the rule expression evaluates to true. Each override specifies how a form element should be changed.
               - name: entityType  | type: string | description: Type of form element being modified by this override.
               - ONE-OF:
                   - name: fieldOptions  | type: FieldOverride | description: Field override settings.
           - name: name  | type: string | description: Human-readable name for the rule.
           - name: namespaceRule  | type: boolean | description: Namespace rules are part of business logic of app owning namespace, have limited editing possibilities
       - name: tags  | type: Tags | description: Tag IDs collections associated with the current entity.
           - name: privateTags  | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors.
               - name: tagIds  | type: Array<string> | description: List of tag IDs
           - name: tags  | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors.
       - name: quizSettings  | type: QuizSettings | description: 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.
           - name: message  | type: RichContent | description: Rich-content message shown on the quiz result (confirmation) page, alongside any score or pass/fail status configured in `results_display`.
           - name: resultsDisplay  | type: string | description: How to display quiz results in the confirmation page. Default: `DO_NOT_DISPLAY`
               enum: DO_NOT_DISPLAY, SCORE, PASSING_STATUS, SCORE_AND_PASSING_STATUS
           - ONE-OF:
               - name: passingScorePoints  | type: number | description: Score required to pass the quiz (in points).
               - name: passingScorePercentage  | type: number | description: Score required to pass the quiz as a percentage (0-100).
           - ONE-OF:
               - name: passingStatusOptions  | type: PassFailMessages | description: Configuration for displaying only the pass/fail message.
                   - name: passMessage  | type: RichContent | description: Message displayed when the user passes the quiz.
                   - name: failMessage  | type: RichContent | description: Message displayed when the user fails the quiz.
               - name: scoreAndPassingStatusOptions  | type: PassFailMessages | description: Configuration for displaying both the score and pass/fail message.
       - name: autoFillContact  | type: string | description: Source used for contact autofill when filling form fields. Default: FORM_INPUT.
           enum: MEMBER_DATA, FORM_INPUT
       - name: submissionAccess  | type: string | description: Controls who can read submissions of this form beyond the standard permission.  Default: `OWNER_AND_COLLABORATORS`
           enum: UNKNOWN_SUBMISSION_ACCESS, OWNER_AND_COLLABORATORS, MEMBERS, PUBLIC

```