Execute booking request

The bookings checkout endpoint allows you to create a booking request with a set of parameters.

Booking Request

PropertyTypeRequiredDescription
startdatetrueStart datetime of the booking request.
enddatetrueEnd datetime of the booking request.
teamidfalseReference to the company (required if no member).
memberidfalseReference to the member (required if no team).
extrasobjectfalseDictionary with keys the IDs of the extras to add to the booking and values - the quantity of the extra.
sourcestringfalseThe origin/source of the bookings.
summarystringfalseBooking title/summary.
descriptionstringfalseLong description of the booking.
tentativebooleanfalseTrue if the booking is not confirmed. Tentative bookings are not charged.
freebooleanfalseTrue if the booking is marked as free. If a booking is marked as free, no fees will be added for it.
sizenumber*falseThe resource size to be used.
countnumbertrueThe count of bookings of this type to be made.
rateidfalseThe resource rate to be used to lookup available resources.
resourceTypeidfalseThe resource type to be used to lookup available resources.
officeidfalseThe office to be used to lookup available resources.

number*: You can use a query instead of a value, for example { size: { $gte: 2 } }, meaning the size must be at least 2

📘

Note

Creating a checkout request without specifying a resourceId will cause the API to automatically select a resource based on the criteria specified in the request, e.g. resource size.

If no criteria is specified the API will choose an available resource at random.

Option 1 - Create a booking associated only with a member.
You can then associate the booking with a team as well.

Option 2 - Create a booking associated only with a team.
You can then associate the booking with a member as well.

Language
Authentication
OAuth2
URL
Click Try It! to start a request and see the response here!