Create Reservation

Reserve a date and time for a potential booking in your organisation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

From our API's perspective there is no difference between reserving a reservation for a completely new booking or a space on an existing group booking that is available.

If at the given start time that you are creating your reservation for there is an available group booking for the service and resource with the same start time that you requested this endpoint will automatically reserve a space on that group booking instead of returning an availability error.

For more information see the following guides:

Body Params
boolean
Defaults to false

If set to true availability will not be restricted by the current date and time. By default this is set to false and any date and time before the current date and time will be considered as unavailable.

boolean
Defaults to false

If set to true availability will not be restricted by your organisation's notice period settings. By default this is set to false and any date and time before the number of minutes/hours/days added onto the current date and time will be considered as unavailable.

boolean
Defaults to false

If set to true availability will not be restricted by your organisation's block period settings. By default this is set to false and any date and time after the number of minutes/hours/days added onto the current date and time will be considered as unavailable.

boolean
Defaults to false

If set to true availability will not be restricted by the service's schedule. By default this is set to false and any date and time outside of the service's schedule will be considered as unavailable.

boolean
Defaults to false

If set to true the availability will return bookings that have enough space as group bookings, regardless if they have online group bookings turned on.

data
object
required
string

A valid IANA time zone that the response's times should be converted to.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json