Home → Event Plugin → API Calls → api/PluginCreateBooking - Create and Confirm Booking
1.8. api/PluginCreateBooking - Create and Confirm Booking
This API call is used to create and confirm bookings in the CRM. 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 – The ID of the user who is logged in and making the booking.
-
eid – The ID of the event being booked.
-
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 | Contact's uid. | String – Max 50 chars |
| eid | The event eid being booked onto. | String – Max 50 chars |
| 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 |
Return Response
This call returns a Boolean of True if successful.