Show / Hide Table of Contents

Calendar.ReadWrite

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 A POST /bookingBusinesses/{id}/getStaffAvailability
V1 A POST /solutions/bookingBusinesses/{id}/getStaffAvailability

Application Permission

Id
Display String
Description

Resources

bookingAppointment

Property Type Description
additionalInformation String Additional information that is sent to the customer when an appointment is confirmed.
anonymousJoinWebUrl String The URL of the meeting to join anonymously.
customers bookingCustomerInformation collection A collection of customer properties for an appointment. An appointment will contain a list of customer information and each unit will indicate the properties of a customer who is part of that appointment. Optional.
customerTimeZone String The time zone of the customer. For a list of possible values, see dateTimeTimeZone.
duration Duration The length of the appointment, denoted in ISO8601 format.
endDateTime dateTimeTimeZone The date, time, and time zone that the appointment ends.
filledAttendeesCount Int32 The current number of customers in the appointment
id String The ID of the bookingAppointment. Read-only.
isLocationOnline Boolean If true, indicates that the appointment will be held online. Default value is false.
joinWebUrl String The URL of the online meeting for the appointment.
maximumAttendeesCount Int32 The maximum number of customers allowed in an appointment. If maximumAttendeesCount of the service is greater than 1, pass valid customer IDs while creating or updating an appointment. To create a customer, use the Create bookingCustomer operation.
optOutOfCustomerEmail Boolean If true indicates that the bookingCustomer for this appointment does not wish to receive a confirmation for this appointment.
postBuffer Duration The amount of time to reserve after the appointment ends, for cleaning up, as an example. The value is expressed in ISO8601 format.
preBuffer Duration The amount of time to reserve before the appointment begins, for preparation, as an example. The value is expressed in ISO8601 format.
price Double The regular price for an appointment for the specified bookingService.
priceType bookingPriceType A setting to provide flexibility for the pricing structure of services. Possible values are: undefined, fixedPrice, startingAt, hourly, free, priceVaries, callUs, notSet, unknownFutureValue.
reminders bookingReminder collection The collection of customer reminders sent for this appointment. The value of this property is available only when reading this bookingAppointment by its ID.
selfServiceAppointmentId String An additional tracking ID for the appointment, if the appointment has been created directly by the customer on the scheduling page, as opposed to by a staff member on the behalf of the customer. Only supported for appointment if maxAttendeeCount is 1.
serviceId String The ID of the bookingService associated with this appointment.
serviceLocation location The location where the service is delivered.
serviceName String The name of the bookingService associated with this appointment.
This property is optional when creating a new appointment. If not specified, it is computed from the service associated with the appointment by the serviceId property.
serviceNotes String Notes from a bookingStaffMember. The value of this property is available only when reading this bookingAppointment by its ID.
smsNotificationsEnabled Boolean If true, indicates SMS notifications will be sent to the customers for the appointment. Default value is false.
staffMemberIds String collection The ID of each bookingStaffMember who is scheduled in this appointment.
startDateTime dateTimeTimeZone The date, time, and time zone that the appointment begins.

bookingStaffMember

Property Type Description
availabilityIsAffectedByPersonalCalendar Boolean True means that if the staff member is a Microsoft 365 user, the Bookings API would verify the staff member's availability in their personal calendar in Microsoft 365, before making a booking.
displayName String The name of the staff member, as displayed to customers. Required.
emailAddress String The email address of the staff member. This can be in the same Microsoft 365 tenant as the business, or in a different email domain. This email address can be used if the sendConfirmationsToOwner property is set to true in the scheduling policy of the business. Required.
id String The ID of the staff member, in a GUID format. Read-only.
isEmailNotificationEnabled Boolean True indicates that a staff member will be notified via email when a booking assigned to them is created or changed.
role bookingStaffRole The role of the staff member in the business. Possible values are: guest, administrator, viewer, externalGuest, unknownFutureValue, scheduler, teamMember. Note that you must use the Prefer: include-unknown-enum-members request header to get the following values from this evolvable enum: scheduler, teamMember. Required.
timeZone String The time zone of the staff member. For a list of possible values, see dateTimeTimeZone.
useBusinessHours Boolean True means the staff member's availability is as specified in the businessHours property of the business. False means the availability is determined by the staff member's workingHours property setting.
workingHours bookingWorkHours collection The range of hours each day of the week that the staff member is available for booking. By default, they are initialized to be the same as the **b

staffAvailabilityItem

Property Type Description
availabilityItems availabilityItem collection Each item in this collection indicates a slot and the status of the staff member.
staffId String The ID of the staff member.
In This Article
Back to top Created by merill | Submit feedback