This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Lists schedules by schedule IDs or schedule owner IDs.
Permissions This endpoint requires the Read Bookings Calendar or the Manage Bookings permission scope. With the Read Bookings Calendar permission scope, the schedule participants are not returned.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates a schedule
Permissions This endpoint requires the Manage Bookings permissions scope
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
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 request remain unchanged.
Array fields, if specified, overwrite the existing arrays, and therefore discards any previous array elements.
The availability.locations
array cannot be updated. Please use the setAvailabilityLocations
endpoint instead.
Permissions This endpoint requires the Manage Bookings permissions scope
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
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 time of cancellation are kept, and all future sessions are removed.
Permissions This endpoint requires the Manage Bookings permissions scope
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
ets a schedule from the calendar.
Permissions This endpoint requires the Read Bookings Calendar or the Manage Bookings permissions scope. With the Read Bookings Calendar permission scope, the schedule participants are not returned.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Updates a session.
The property values specified replace the existing values. If a property is not specified in the request it will remain unchanged.
Array properties, if specified, overwrite the existing array and all of its elements.
The participants
array cannot be updated.
Use the participantNotification property to send an email to the participants notifying them of the change.
Permissions This endpoint requires the Manage Bookings permissions scope
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Deletes a session from a schedule.
Use the participantNotification
property to send an email to the participants when the session is deleted.
When deleting a session of type "EVENT"
where a booking exists, the booking's status is updated to "CANCELED"
.
To delete a set of recurring sessions, specify the session's recurringSessionId
in the sessionId
property of the request parameters.
Permissions This endpoint requires the Manage Bookings permissions scope
@snippet [deleteSession.es6=Delete a session.]
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Returns a session from the calendar.
Permissions This endpoint requires the Read Bookings Calendar or the Manage Bookings permission scope. With the Read Bookings Calendar permission scope, the session participants are not returned.
This method has been deprecated, and will be replaced in the future.
Returns multiple sessions from the calendar.
Permissions This endpoint requires the Read Bookings Calendar or the Manage Bookings permission scope With the Read Bookings Calendar permission scope, the sessions return without participants.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Permission Scopes
For app development, you must have one of the following permission scopes:ONE OF: