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

Schedules and Sessions

Manage schedules & session Learn more.

Guides

Additional information about this section

Schedule
  • OBJECT
  • POST

    Creates a schedule. Permissions This endpoint requires the Manage Bookings permissions scope

  • GET

    Returns a schedule from the calendar. Permissions This endpoint requires the Read Bookings Calendar or the Manage Bookings permissions scope. With the Read ...

  • GET

    Lists schedules by schedule IDs or schedule owner IDs. Permissions This endpoint requires the Read Bookings Calendar or the Manage Bookings permission scope. ...

  • PATCH

    Updates a schedule. This method supports patch semantics. The field values you specify replace the existing values. Fields that you don’t specify in the ...

  • POST

    Cancels a schedule. Equivalent to batch cancel of sessions linked to a single schedule. The schedule changes to status = CANCELED - all sessions up until the ...

  • WEBHOOK
Participants
  • POST

    Adds a participant to a schedule or to a specific session. Permissions This endpoint requires the Manage Bookings permissions scope

  • DELETE

    Removes a participant from a schedule or from a specific session. Permissions This endpoint requires the Manage Bookings permissions scope

  • PATCH

    Updates participant details. The field values you specify replace the existing values. Fields that you don’t specify in the request remain unchanged. Array ...

Session
  • POST

    Creates a session (adds a session to a schedule). Permissions This endpoint requires the Manage Bookings permissions scope

  • GET

    Returns a session from the calendar. Permissions This endpoint requires the Read Bookings Calendar or the Manage Bookings permission scope. With the Read ...

  • POST

    Returns multiple sessions from the calendar. Permissions This endpoint requires the Read Bookings Calendar or the Manage Bookings permission scope With the ...

  • PATCH

    Updates a session. The field values you specify replace the existing values. Fields that you don’t specify in the request remain unchanged. Array fields, if ...

  • POST

    Deletes a session from a schedule. Permissions This endpoint requires the Manage Bookings permissions scope