Home → Event Plugin → API Calls → api/PluginCreateBookingBulk - Create and Confirm Bookings in Bulk
1.11. api/PluginCreateBookingBulk - Create and Confirm Bookings in Bulk
This API call is used to create and confirm bookings in the CRM in bulk. It supports both free and paid bookings. For paid bookings, payment must be collected before submitting this request.
To complete the booking, you must provide the following parameters:
-
uid – Optional: The ID of the user who is logged in and making the booking.
-
eid – The ID of the event being booked.
-
BookingsArray – A JSON array of bookings providing fields as detailed below.
-
EventPriceID – The specific pricing option being used for the booking.
-
AutoConfirmation – Indicates whether an automatic confirmation should be sent.
Before calling this endpoint, you must first check the api/PluginCalendarDetail to:
-
Confirm that BookOnline is set to true for the event.
-
Retrieve the available EventPriceID options that the specified uid is eligible to book.
Only proceed with the booking request once these conditions have been verified.
Parameters To Submit
| Parameter | Parameter Help | Parameter Data Type |
| uid | (Optional) Contact's uid. | String – Max 50 chars |
| eid | The event eid being booked onto. | String – Max 50 chars |
| BookingsArray | The number of items in this array will be based on the number of bookings to be processed. Please refer to BookingsArray below for submission parameters. | String - JSON Array |
| EventPriceID | The price ID used to book. Taken from api/PluginCalendarDetail. | Integer |
| AutoConfirmation | True/False: whether a confirmation email should be sent to the contact. | Boolean |
| API Key |
BookingsArray
| Parameter | Parameter Help | Parameter Data Type |
| TBCBooking | If the attendee for this booking is TBC, set to true. All subsequent values will be ignored. | Boolean |
| uid | (Optional) The ID of the contact record being booked in this place. | String – Max 50 chars |
| ContactFirstName* | If no uid is provided and TBCBooking is false, this parameter must be provided. The first name of the attendee. |
String |
| ContactLastName* | If no uid is provided and TBCBooking is false, this parameter must be provided. The last name of the attendee. |
String |
| ContactEmail* | If no uid is provided and TBCBooking is false, this parameter must be provided. The email address of the attendee. |
String |
| Company* | If no uid is provided and TBCBooking is false, this parameter must be provided. The company name of the attendee. |
String |
| SpecialRequests | (Optional) Any special requests/dietary requirements of the attendee being booked in this place. If TBC, booking information is still accepted. |
String – Max 250 chars |
| BookingNotes | (Optional) Additional booking notes for the attendee being booked in this place. If TBC, booking information is still accepted. |
String – Max 250 chars |
* If no attendee uid is provided and TBCBooking is false, the required guest details are ContactFirstName, ContactLastName, ContactEmail, and Company. If any are missing or blank, the booking is created as TBC.
For any bookings that are paid, bookings are grouped under one invoice, but no invoice is created if the booker uid is empty or the effective price is zero.
Return Response
This call returns a Boolean of True if successful.