Search.../
  1. Home
  2. Getting Started
  3. Overview
Generate a test token to explore our APIs

Bookings

Manage bookings, create, update and cancel bookings. Learn more.

Guides

Additional information about this section

Availability
  • GET

    Returns the current availability of a requested entity. Based on the requested entity, validate there is enough spots left. When invoking on a locked session, ...

  • POST

    Lock a session for bookings. When invoking this API with a sessionId, it returns a key that will enable to book the given session. Once the session is locked - ...

  • POST

    Unlock a locked session for bookings. When invoking this API with a sessionId and its key, the session will be available for bookings. Permissions This ...

Bookings
  • OBJECT

    The booking domain object

  • POST

    Book a service. This method has 2 modes of operation: 1. Book by a customer. 2. Book by the business (e.g. the business owner) on behalf of a customer. When ...

  • POST

    Cancel an existing booking. When invoked by a customer flow, this action is validated against the service's bookings policy. Cancelling a bookings triggers ...

  • POST

    Checkout a booking. When invoking this method the following takes place: - The availability of the requested slot/session/schedule is validated. - The Booking ...

  • POST

    Confirm a booking request. When invoking this API the following takes place: - The participant status on the session changes to APPROVED. - Slot availability ...

  • POST

    Decline a booking request. When invoking this API the following takes place: - The participant status on the session changes to DECLINED. - The corresponding ...

  • POST

    Reschedule a Booking. When rescheduling a booking of a slot, the session on the calendar is updated as well. Note: Rescheduling a booking to a schedule is not ...

  • POST

    Set the booking attendance status.

  • POST

    Update client’s information on a Booking.

  • WEBHOOK
Bookings Reader
  • GET

    Returns a list of bookings; Based on the invoker permissions and the request query. Query object support: - filter: supports - bookingId - query for a specific ...