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:
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.
Note: While the names of the object and endpoints in this API say "Form", such as "Create Form", they're always referring to form schemas.
It's important to note the following points before starting to code:
namespace property. To use your form schemas, the user must have their associated apps installed.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.
| 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 |