Update bookingservice

Article
03/07/2024

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 bookingService object in the specified bookingBusiness.

The following are some examples you can customize for a service:

Price
Typical length of an appointment
Reminders
Any, time buffer to set up before or finish up after the service
Scheduling policy parameters such as minimum notice to book or cancel, and whether customers can select specific staff members for an appointment.

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)	Bookings.ReadWrite.All	Bookings.Manage.All
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Bookings.ReadWrite.All	Bookings.Manage.All

HTTP request

PATCH /solutions/bookingbusinesses/{id}/services/{id}

Optional request headers

Name	Description
Authorization	Bearer {code}. Required.

Request body

In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.

Property	Type	Description
defaultDuration	Duration	The default length of the service, represented in numbers of days, hours, minutes, and seconds. For example, P11D23H59M59.999999999999S.
defaultLocation	location	The default physical location for the service.
defaultPrice	Double	The default monetary price for the service.
defaultPriceType	bookingPriceType	The default way the service is charged. Possible values are: `undefined`, `fixedPrice`, `startingAt`, `hourly`, `free`, `priceVaries`, `callUs`, `notSet`, `unknownFutureValue`.
defaultReminders	bookingReminder collection	The default set of reminders for an appointment of this service. The value of this property is available only when reading this bookingService by its ID.
description	String	A text description for the service.
displayName	String	A service name.
id	String	Read-only.
isAnonymousJoinEnabled	Boolean	`True` if the URL to join the appointment anonymously (anonymousJoinWebUrl) is generated for the appointment booked for this service.
isCustomerAllowedToManageBooking	Boolean	Indicates that the customer can manage bookings created by the staff. The default value is `false`.
isHiddenFromCustomers	Boolean	True means this service isn't available to customers for booking.
isLocationOnline	Boolean	True indicates that the appointments for the service are held online. The default value is `false`.
languageTag	String	The language of the self-service booking page.
notes	String	Additional information about this service.
postBuffer	Duration	The time to buffer after an appointment for this service ends, and before the next customer appointment can be booked.
preBuffer	Duration	The time to buffer before an appointment for this service can start.
schedulingPolicy	bookingSchedulingPolicy	The set of policies that determine how appointments for this type of service should be created and managed.
smsNotificationsEnabled	Boolean	True indicates SMS notifications can be sent to the customers for the appointment of the service. The default value is `false`.
staffMemberIds	String collection	Represents those staff members who provide this service.
customQuestions	bookingQuestionAssignment collection	This contains the set of custom questions associated with a particular service. Optional.
maximumAttendeesCount	Int32	The maximum number of customers allowed in a service.

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 updates the duration of the specified service.

PATCH https://graph.microsoft.com/beta/solutions/bookingbusinesses/contosolunchdelivery@contoso.com/services/57da6774-a087-4d69-b0e6-6fb82c339976
Content-type: application/json

{
    "@odata.type":"#microsoft.graph.bookingService",
    "defaultDuration":"PT30M"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new BookingService
{
	OdataType = "#microsoft.graph.bookingService",
	DefaultDuration = TimeSpan.Parse("PT30M"),
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Solutions.BookingBusinesses["{bookingBusiness-id}"].Services["{bookingService-id}"].PatchAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta solutions booking-businesses services patch --booking-business-id {bookingBusiness-id} --booking-service-id {bookingService-id} --body '{\
    "@odata.type":"#microsoft.graph.bookingService",\
    "defaultDuration":"PT30M"\
}\
'

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



import (
	  "context"
	  abstractions "github.com/microsoft/kiota-abstractions-go"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewBookingService()
defaultDuration , err := abstractions.ParseISODuration("PT30M")
requestBody.SetDefaultDuration(&defaultDuration) 

services, err := graphClient.Solutions().BookingBusinesses().ByBookingBusinessId("bookingBusiness-id").Services().ByBookingServiceId("bookingService-id").Patch(context.Background(), requestBody, nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

BookingService bookingService = new BookingService();
bookingService.setOdataType("#microsoft.graph.bookingService");
PeriodAndDuration defaultDuration = PeriodAndDuration.ofDuration(Duration.parse("PT30M"));
bookingService.setDefaultDuration(defaultDuration);
BookingService result = graphClient.solutions().bookingBusinesses().byBookingBusinessId("{bookingBusiness-id}").services().byBookingServiceId("{bookingService-id}").patch(bookingService);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

const bookingService = {
    '@odata.type':'#microsoft.graph.bookingService',
    defaultDuration: 'PT30M'
};

await client.api('/solutions/bookingbusinesses/contosolunchdelivery@contoso.com/services/57da6774-a087-4d69-b0e6-6fb82c339976')
	.version('beta')
	.update(bookingService);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\BookingService;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new BookingService();
$requestBody->setOdataType('#microsoft.graph.bookingService');
$requestBody->setDefaultDuration(new \DateInterval('PT30M'));

$result = $graphServiceClient->solutions()->bookingBusinesses()->byBookingBusinessId('bookingBusiness-id')->services()->byBookingServiceId('bookingService-id')->patch($requestBody)->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


from msgraph import GraphServiceClient
from msgraph.generated.models.booking_service import BookingService

graph_client = GraphServiceClient(credentials, scopes)

request_body = BookingService(
	odata_type = "#microsoft.graph.bookingService",
	default_duration = "PT30M",
)

result = await graph_client.solutions.booking_businesses.by_booking_business_id('bookingBusiness-id').services.by_booking_service_id('bookingService-id').patch(request_body)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

HTTP/1.1 204 No Content

Update bookingservice

Permissions

HTTP request

Optional request headers

Request body

Response

Example

Request

Response

Feedback

Feedback

Additional resources