Form Object

Attributes
idstringRead-onlyformat GUID
Form ID.

headerobject
Form header

actionLabelsobject
Available payment actions.

nameobject
Deprecated. Please use first_name and set name to an empty value. Either name or first_name must be provided, if a value exists for name it will be copied to first_name otherwise, the value of first_name will be copied to name. When using first_name, name must always be set to an empty value.

firstNameobject
Either name or first_name must be provided, if a value exists for name it will be copied to first_name otherwise, the value of first_name will be copied to name. When using first_name, name must always be set to an empty value.

lastNameobject
Customer's last name.

emailobject
Customer's email address.

phoneobject
Customer's phone number.

numberOfParticipantsobject
Number of participants being booked to the service (displayed in Wix Bookings UI only for services that allow booking multiple people per booking).

addressobject
Customer's address (displayed in Wix Bookings UI only when a service’s location is set to "Customer’s Place").

customFieldsArray <FormField>maxItems 64
Custom fields which can be added to the form.
Was this helpful?
Yes
No

GetGet Form

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Gets a form

Permissions This endpoint requires the Read Bookings - Public Data or Read Bookings - Including Participants permissions scope

Endpoint
GET
https://www.wixapis.com/bookings/v1/forms/{id}

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

GetList

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

List all forms

Permissions This endpoint requires the Read Forms - Public Data or Read Bookings - Including Participants permissions scope

Endpoint
GET
https://www.wixapis.com/bookings/v1/forms/all

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PutUpdate Form

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates a form.

Endpoint
PUT
https://www.wixapis.com/bookings/v1/forms

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostCreate Form

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a form.

Endpoint
POST
https://www.wixapis.com/bookings/v1/forms

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

Form Notification

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
formobject

eventstring
3 supported values:
UpdatedDeletedCreated
Was this helpful?
Yes
No