About the Form API

With the Form API, you can customize a registration form for site visitors to fill out with their contact details and other relevant information. The form also defines which elements are rendered on the site page during the registration process (RSVP or checkout).

A registration form is comprised of multiple controls. Each control may include multiple field inputs. For example, the address control may include inputs for street address, city, state, country, and zip code.

By default, all forms include controls for name and email.

Additional controls include:

  • additionalGuests
  • address
  • checkBox
  • date
  • dropdown
  • phone
  • radioButton
  • text

The Form API allows you to:

  • Add, delete, and update controls with relevant fields on a draft form.
  • Publish or discard changes in a draft form.
  • Update messages displayed on a form.
  • Get information about a form.

Before you begin

It's important to note the following:

  • Each event has one published form and one draft form.
  • All calls to add, update, or delete controls affect the draft form, which can be published at any time with Publish Draft.
  • By default, each form includes controls for name and email that can't be removed.

Terminology

  • Control: A specific block of a registration form that contains an input or multiple inputs. By default, all forms include controls for name and email.
  • Event: A gathering organized by a Wix user for a group of people.
  • Registration form: An interface provided by a Wix user to collect essential information from individuals who wish to sign up, enroll, or participate in an event, program, service, or membership.
Did this help?
OSZAR »