About the Form Schemas API

The Form Schemas API allows you to create and manage form schemas. These are structural blueprints that define forms on Wix sites. A form schema specifies the fields, validation rules, layout, and behavior settings that determine how forms appear and function. For more information about how forms appear on a site, see Wix Forms.

When working with the Forms APIs, you are always working with form schemas. For the sake of simplicity, the terms form and form schema are used interchangeably.

With the Form Schemas API, you can:

• Create custom form schemas with specific field types, validation rules, and layouts.
• Clone existing schemas to quickly replicate successful form designs.
• Update schema structure, field configurations, and display settings.
• Manage schema lifecycle including enabling, disabling, and organizing schemas by namespace.
• Configure advanced features like spam protection, submission limits, and post-submission actions.

Each app made by Wix that supports forms has its own unique identifier called a namespace. A form schema's namespace property defines which namespace it belongs to.

Form schemas are used in apps made by Wix as blueprints for generating the forms they add to user's sites. For example, when user selects a form template in Wix Forms and adds it to their site, Wix Forms creates a new form using the corresponding form schema.

Each form schema belongs to a specific namespace which identifies the app that owns it. You can create form schemas in any namespace by specifying the namespace in your form schema's namespace property. For example, you can create an app that creates form schemas in the Wix Forms namespace. Wix Forms users will then be able to download your app and get access to your form schemas through the Wix Forms app.

Form submissions are recorded per form schema. A user may have multiple instances of forms on their site with the same form schema, but there is no distinction between these instances in the submissions.

Before you begin

It's important to note the following points before starting to code:

• Each form schema must belong to an app's namespace, which is assigned in the form schema's namespace property. To use your form schemas, the user must have their associated apps installed.

Form deletion and the trash bin

You can delete form schemas by calling the Delete Form method with the formID. This doesn't permanently delete the form schema, but instead moves it to the trash bin.

Form schemas are kept in the trash bin for 90 days before they're permanently deleted. When a form schema is permanently deleted, all form submissions associated with that form schema are also deleted.

Deleted form schemas aren't retrieved by standard methods, such as Query Forms, but can be retrieved with methods specifically intended for deleted form schemas, such as Query Deleted Forms.

Namespaces of apps made by Wix

App Name	Namespace
Wix Pricing Plans	wix.pricing_plans.v1.custom_form
Wix Forms	wix.form_app.form
Wix eCom	wix.ecom.v1.checkout
Wix Quizzes	wix.achievements.quizzes.v1.quiz
Wix Bookings	wix.bookings.v2.bookings
Wix Contacts	wix.contacts.v4.contact

Use cases

• Create a custom lead-capture form
• Update an existing form with new fields
• Sync form data with an external application

Terminology

• Form schema: The structural definition of a form, including its fields, layout, validation rules, and behavior settings.
• Namespace: A unique identifier for the app that owns the form schema.
• Form field: An individual input element within a form schema, such as for text, email, or dropdown options, and its associated validation and display properties.
• Field validation: Rules that determine what input is acceptable for each form field, including data type, format, and content requirements.
• Limitation rule: Settings that automatically disable form submissions when certain thresholds are reached, such as maximum submission count or deadline dates.
• Post-submission trigger: Automated actions that are executed after a form submission is received, enabling integration with other Wix services and external systems.
• Submitter: The end user filling out the form.