Edit

Update bookingAppointment

  • Article

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Update the properties of a bookingAppointment object in the specified bookingBusiness.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet
✅ ✅ ✅ ❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) BookingsAppointment.ReadWrite.All Bookings.Manage.All, Bookings.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application BookingsAppointment.ReadWrite.All Bookings.Manage.All, Bookings.Read.All, Bookings.ReadWrite.All

Note

If you create a custom app using application permissions, you must follow the Business rules validation.

HTTP request

PATCH /solutions/bookingBusinesses/{id}/appointments/{id}

Optional request headers

Name Description
Authorization Bearer {code}. Required.

Request body

In the request body, supply only the values for properties that should be updated. Existing properties that aren't included in the request body maintains their previous values or be recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Property Type Description
customerEmailAddress String The SMTP address of the bookingCustomer who is booking the appointment.
customerId String The ID of the bookingCustomer for this appointment. If no ID is specified when an appointment is created, then a new bookingCustomer object is created. Once set, you should consider the customerId immutable.
customerLocation location Represents location information for the bookingCustomer who is booking the appointment.
customerName String The customer's name.
customerNotes String Notes from the customer associated with this appointment. You can get the value only when reading this bookingAppointment by its ID.
You can set this property only when initially creating an appointment with a new customer. After that point, the value is computed from the customer represented by customerId.
customerPhone String The customer's phone number.
customers bookingCustomerInformation collection It lists down the customer properties for an appointment. An appointment contains a list of customer information and each unit indicates 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.
end dateTimeTimeZone The date, time, and time zone that the appointment ends.
invoiceAmount Double The billed amount on the invoice.
invoiceDate dateTimeTimeZone The date, time, and time zone of the invoice for this appointment.
invoiceId String The ID of the invoice.
invoiceStatus string The status of the invoice. Possible values are: draft, reviewing, open, canceled, paid, and corrective.
isCustomerAllowedToManageBooking Boolean Indicates that the customer can manage bookings created by the staff. The default value is false.
invoiceUrl String The URL of the invoice in Microsoft Bookings.
filledAttendeesCount Int32 The current number of customers in the appointment. Required.
isLocationOnline Boolean True indicates that the appointment is held online. The default value is false.
maximumAttendeesCount Int32 The maximum number of customers allowed in the appointment. Required.
optOutOfCustomerEmail Boolean True indicates that the bookingCustomer for this appointment doesn't 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 Another tracking ID for the appointment, if the appointment was created directly by the customer on the scheduling page, as opposed to by a staff member on behalf of the customer.
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's 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 True indicates SMS notifications will be sent to the customers for the appointment. The default value is false.
staffMemberIds String collection The ID of each bookingStaffMember who is scheduled in this appointment.
start dateTimeTimeZone The date, time, and time zone the appointment begins.

Note

If the maximum number of customers (maximumAttedeesCount) allowed in the service is greater than 1:

  • Make sure that the customers exist in the Booking Calendar. If they don’t, create using the Create bookingCustomer operation.
  • Pass valid customer IDs when you create or update the appointment. If the customer ID is invalid, that customer won't be included in the appointment object.

Response

If successful, this method returns a 204 No Content response code. It doesn't return anything in the response body.

Example

Request

The following example changes the date of service by a day and updates the invoice date.

PATCH https://graph.microsoft.com/beta/solutions/bookingBusinesses/contosolunchdelivery@contoso.com/appointments/AAMkADKnAAA=
Content-type: application/json

{
    "@odata.type":"#microsoft.graph.bookingAppointment",
    "end":{
        "@odata.type":"#microsoft.graph.dateTimeTimeZone",
        "dateTime":"2018-05-06T12:30:00.0000000+00:00",
        "timeZone":"UTC"
    },
    "invoiceDate":{
        "@odata.type":"#microsoft.graph.dateTimeTimeZone",
        "dateTime":"2018-05-06T12:30:00.0000000+00:00",
        "timeZone":"UTC"
    },
    "start":{
        "@odata.type":"#microsoft.graph.dateTimeTimeZone",
        "dateTime":"2018-05-06T12:00:00.0000000+00:00",
        "timeZone":"UTC"
    }
}

Response

The following example shows the response.

HTTP/1.1 204 No Content