This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Deprecation Notice
This endpoint has been replaced with Query Availability and will be removed on December 31, 2023. If your app uses this endpoint, we recommend updating your code as soon as possible.
Returns the current availability of a requested entity by checking whether there are enough spots left based on the requested party size.
When checking the availability an appointment, class or course, use the following parameter objects:
- Appointments. Use the slot object from list slots to populate the
session - Courses. Use the course's
scheduleId - Classes. Use
sessionId
When calling Is Available on a locked session, the returned available property is false.
Permissions This endpoint requires the Read Bookings - Public Data permission scope.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Lock a session to prevent bookings.
When invoking Lock with a sessionId, the session can no longer be booked or checked out unless the returned key is passed in the request.
Lock returns a key that can also be used with Unlock to re-enable booking and checkout for the given session.
Once a session is locked:
- When calling Is Available, the returned value of the
availableproperty isfalse. - Calling Book or Checkout will fail unless the correct key is passed in the request.
Permissions This endpoint requires the Manage Bookings permission scope.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Unlock a locked session for bookings. When calling Unlock with a sessionId and its key, the session will be available for bookings, subject to availability.
Permissions This endpoint requires the Manage Bookings permission scope.