Booking Form API

The Booking API allows members to offer a preset number of resources for booking through an online form. This feature can be used to sell a limited quantity of tickets for an event on a registration form or put up a fixed inventory of goods on sale, like t-shirts of different sizes.

The booking form is automatically disabled once the event is fully booked (or items for sale are sold out), or the booking/selling period has ended. As explained in this document, the Booking API allows the form owner to access information about bookings and events online. Feel free to try this booking form demo, quickly make a simple booking form, learn how bookings work, and contact us if you have any questions.

Events & Other Bookable Resources

A bookable resource is called an event. An event can be anything with a name, date and a limited number of bookable slots. A bookable resource is typically an event associated with a number of tickets that can be booked via an online form, but it could also be a product with the corresponding inventory.

How to Create an Event/Bookable Resource

To create an event, log in to the API Console and submit a POST request to https://formsmarts.com/api/v1/events, providing a value for each of the required parameters listed below.

Listing Events/Bookable Resources

To retrieve the details of events or bookable resources, submit a GET request. All parameters are optional.

To get the details of a particular event, append the event's ID to the API endpoint URL and submit a GET request:

Fetching Events/Bookable Resources Data on a Booking Form

Basic information about active events is publicly available so it may be integrated to a booking form.

Canceling an Event/Bookable Resource

To cancel an event (a.k.a. bookable resource), append the event's ID to the API endpoint and submit a DELETE request:

An event may only be deleted if it doesn't have bookings. Cancel the associated bookings first if needed.

How to Make a Booking Form

You can easily make a simple booking form via the form builder, but if you would like to adjust booking options, you'll need to use the Booking API instead.

To create an online booking form via the Booking API:

1. Create a form, adding at least one booking field like on this demo. A booking field is a simple text box that should allow Letters + Numbers.
2. Create an event as outlined in the previous section
3. Integrate the form with the Booking API as explained next.

Associate Events/Booking Resources with a Form

To associate an event (or any bookable resource) with a form, sign in to the API Console and submit a PUT request to the API endpoint below, replacing Form_ID with the ID of the form. All parameters but booking_fields are optional.

Review a Form's Booking Integration

To list the current integration parameters of a form, submit a GET request.

Remove a Form's Booking Integration

To cancel a form's booking integration, submit a DELETE request.

Managing Bookings

Booking an Event

To book a slot for event, send a POST request. A slot will be pre-booked. A booking form must be submitted within 30 minutes to confirm the booking.

Note: List events as described above to find out the ID of an event.

Canceling a Booking

To cancel a booking, append the booking's ID to the URL and send a DELETE request:

Listing the Details of a Booking

To retrieve the details of a booking, append the booking's ID to the URL and submit a GET request:

Listing All Bookings for an Event

To list all bookings for an event, insert the event's ID in the URL and submit a GET request: