bookingAppointment resource type

Namespace: microsoft.graph

Represents a customer appointment for a bookingService, performed by a set of staff members, provided by a Microsoft Bookings business.

Methods

Method Return Type Description
List appointments bookingAppointment collection Get a list of bookingAppointment objects in the specified bookingBusiness.
Create bookingAppointment bookingAppointment Create a new bookingAppointment for the specified bookingBusiness.
Get bookingAppointment bookingAppointment Read the properties and relationships of bookingAppointment object.
Update bookingAppointment Update a bookingAppointment object.
Delete None Delete a bookingAppointment object.
Cancel None Cancel a bookingAppointment object.

Properties

Property Type Description
additionalInformation String Additional information that is sent to the customer when an appointment is confirmed.
customers bookingCustomerInformation collection It lists down the 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.

Relationships

None.

JSON representation

The following is a JSON representation of the resource.

{
  "customers": [
    {
      "@odata.type": "microsoft.graph.bookingCustomerInformation"
    }
  ],
  "duration": "String (timestamp)",
  "endDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
  "id": "String (identifier)",
  "isLocationOnline": "Boolean",
  "joinWebUrl": "String",
  "optOutOfCustomerEmail": "Boolean",
  "postBuffer": "String (timestamp)",
  "preBuffer": "String (timestamp)",
  "price": "Integer",
  "priceType": {"@odata.type": "microsoft.graph.bookingPriceType"},
  "reminders": [{"@odata.type": "microsoft.graph.bookingReminder"}],
  "selfServiceAppointmentId": "String",
  "serviceId": "String",
  "serviceLocation": {"@odata.type": "microsoft.graph.location"},
  "serviceName": "String",
  "serviceNotes": "String",
  "smsNotificationsEnabled": "Boolean",
  "staffMemberIds": ["String"],
  "startDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
  "maximumAttendeesCount": "Integer",
  "filledAttendeesCount": "Integer"
}