Update-MgBookingBusinessService

  • Reference
Module:
Microsoft.Graph.Bookings

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.

Note

To view the beta release of this cmdlet, view Update-MgBetaBookingBusinessService

Syntax

Update-MgBookingBusinessService
      -BookingBusinessId <String>
      -BookingServiceId <String>
      [-ResponseHeadersVariable <String>]
      [-AdditionalInformation <String>]
      [-AdditionalProperties <Hashtable>]
      [-CustomQuestions <IMicrosoftGraphBookingQuestionAssignment[]>]
      [-DefaultDuration <TimeSpan>]
      [-DefaultLocation <IMicrosoftGraphLocation>]
      [-DefaultPrice <Double>]
      [-DefaultPriceType <BookingPriceType>]
      [-DefaultReminders <IMicrosoftGraphBookingReminder[]>]
      [-Description <String>]
      [-DisplayName <String>]
      [-Id <String>]
      [-IsAnonymousJoinEnabled]
      [-IsHiddenFromCustomers]
      [-IsLocationOnline]
      [-LanguageTag <String>]
      [-MaximumAttendeesCount <Int32>]
      [-Notes <String>]
      [-PostBuffer <TimeSpan>]
      [-PreBuffer <TimeSpan>]
      [-SchedulingPolicy <IMicrosoftGraphBookingSchedulingPolicy>]
      [-SmsNotificationsEnabled]
      [-StaffMemberIds <String[]>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgBookingBusinessService
      -BookingBusinessId <String>
      -BookingServiceId <String>
      -BodyParameter <IMicrosoftGraphBookingService>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgBookingBusinessService
      -InputObject <IBookingsIdentity>
      [-ResponseHeadersVariable <String>]
      [-AdditionalInformation <String>]
      [-AdditionalProperties <Hashtable>]
      [-CustomQuestions <IMicrosoftGraphBookingQuestionAssignment[]>]
      [-DefaultDuration <TimeSpan>]
      [-DefaultLocation <IMicrosoftGraphLocation>]
      [-DefaultPrice <Double>]
      [-DefaultPriceType <BookingPriceType>]
      [-DefaultReminders <IMicrosoftGraphBookingReminder[]>]
      [-Description <String>]
      [-DisplayName <String>]
      [-Id <String>]
      [-IsAnonymousJoinEnabled]
      [-IsHiddenFromCustomers]
      [-IsLocationOnline]
      [-LanguageTag <String>]
      [-MaximumAttendeesCount <Int32>]
      [-Notes <String>]
      [-PostBuffer <TimeSpan>]
      [-PreBuffer <TimeSpan>]
      [-SchedulingPolicy <IMicrosoftGraphBookingSchedulingPolicy>]
      [-SmsNotificationsEnabled]
      [-StaffMemberIds <String[]>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgBookingBusinessService
      -InputObject <IBookingsIdentity>
      -BodyParameter <IMicrosoftGraphBookingService>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

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.

Parameters

-AdditionalInformation

Additional information that is sent to the customer when an appointment is confirmed.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AdditionalProperties

Additional Parameters

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BodyParameter

Represents a particular service offered by a booking business. To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Type:IMicrosoftGraphBookingService
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-BookingBusinessId

The unique identifier of bookingBusiness

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-BookingServiceId

The unique identifier of bookingService

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CustomQuestions

Contains the set of custom questions associated with a particular service. To construct, see NOTES section for CUSTOMQUESTIONS properties and create a hash table.

Type:IMicrosoftGraphBookingQuestionAssignment[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultDuration

The default length of the service, represented in numbers of days, hours, minutes, and seconds. For example, P11D23H59M59.999999999999S.

Type:TimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultLocation

location To construct, see NOTES section for DEFAULTLOCATION properties and create a hash table.

Type:IMicrosoftGraphLocation
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultPrice

The default monetary price for the service.

Type:Double
Position:Named
Default value:0
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultPriceType

Represents the type of pricing of a booking service.

Type:BookingPriceType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultReminders

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. To construct, see NOTES section for DEFAULTREMINDERS properties and create a hash table.

Type:IMicrosoftGraphBookingReminder[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

A text description for the service.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayName

A service name.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Headers

Optional headers that will be added to the request.

Type:IDictionary
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Id

The unique identifier for an entity. Read-only.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IBookingsIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-IsAnonymousJoinEnabled

True if the URL to join the appointment anonymously (anonymousJoinWebUrl) will be generated for the appointment booked for this service.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IsHiddenFromCustomers

True means this service is not available to customers for booking.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IsLocationOnline

True indicates that the appointments for the service will be held online. Default value is false.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LanguageTag

The language of the self-service booking page.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MaximumAttendeesCount

The maximum number of customers allowed in a service. 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.

Type:Int32
Position:Named
Default value:0
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Notes

Additional information about this service.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PostBuffer

The time to buffer after an appointment for this service ends, and before the next customer appointment can be booked.

Type:TimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PreBuffer

The time to buffer before an appointment for this service can start.

Type:TimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:ActionPreference
Aliases:proga
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:String
Aliases:RHV
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SchedulingPolicy

This type represents the set of policies that dictate how bookings can be created in a Booking Calendar. To construct, see NOTES section for SCHEDULINGPOLICY properties and create a hash table.

Type:IMicrosoftGraphBookingSchedulingPolicy
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SmsNotificationsEnabled

True indicates SMS notifications can be sent to the customers for the appointment of the service. Default value is false.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-StaffMemberIds

Represents those staff members who provide this service.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Graph.PowerShell.Models.IBookingsIdentity

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphBookingService

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphBookingService

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

BODYPARAMETER <IMicrosoftGraphBookingService>: Represents a particular service offered by a booking business.

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [AdditionalInformation <String>]: Additional information that is sent to the customer when an appointment is confirmed.
  • [CustomQuestions <IMicrosoftGraphBookingQuestionAssignment- []>]: Contains the set of custom questions associated with a particular service.
    • [IsRequired <Boolean?>]: The ID of the custom question.
    • [QuestionId <String>]: Indicates whether it's mandatory to answer the custom question.
  • [DefaultDuration <TimeSpan?>]: The default length of the service, represented in numbers of days, hours, minutes, and seconds. For example, P11D23H59M59.999999999999S.
  • [DefaultLocation <IMicrosoftGraphLocation>]: location
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Address <IMicrosoftGraphPhysicalAddress>]: physicalAddress
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [City <String>]: The city.
      • [CountryOrRegion <String>]: The country or region. It's a free-format string value, for example, 'United States'.
      • [PostalCode <String>]: The postal code.
      • [State <String>]: The state.
      • [Street <String>]: The street.
    • [Coordinates <IMicrosoftGraphOutlookGeoCoordinates>]: outlookGeoCoordinates
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [Accuracy <Double?>]: The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.
      • [Altitude <Double?>]: The altitude of the location.
      • [AltitudeAccuracy <Double?>]: The accuracy of the altitude.
      • [Latitude <Double?>]: The latitude of the location.
      • [Longitude <Double?>]: The longitude of the location.
    • [DisplayName <String>]: The name associated with the location.
    • [LocationEmailAddress <String>]: Optional email address of the location.
    • [LocationType <String>]: locationType
    • [LocationUri <String>]: Optional URI representing the location.
    • [UniqueId <String>]: For internal use only.
    • [UniqueIdType <String>]: locationUniqueIdType
  • [DefaultPrice <Double?>]: The default monetary price for the service.
  • [DefaultPriceType <BookingPriceType?>]: Represents the type of pricing of a booking service.
  • [DefaultReminders <IMicrosoftGraphBookingReminder- []>]: 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.
    • [Message <String>]: The message in the reminder.
    • [Offset <TimeSpan?>]: The amount of time before the start of an appointment that the reminder should be sent. It's denoted in ISO 8601 format.
    • [Recipients <String>]: bookingReminderRecipients
  • [Description <String>]: A text description for the service.
  • [DisplayName <String>]: A service name.
  • [IsAnonymousJoinEnabled <Boolean?>]: True if the URL to join the appointment anonymously (anonymousJoinWebUrl) will be generated for the appointment booked for this service.
  • [IsHiddenFromCustomers <Boolean?>]: True means this service is not available to customers for booking.
  • [IsLocationOnline <Boolean?>]: True indicates that the appointments for the service will be held online. Default value is false.
  • [LanguageTag <String>]: The language of the self-service booking page.
  • [MaximumAttendeesCount <Int32?>]: The maximum number of customers allowed in a service. 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.
  • [Notes <String>]: Additional information about this service.
  • [PostBuffer <TimeSpan?>]: The time to buffer after an appointment for this service ends, and before the next customer appointment can be booked.
  • [PreBuffer <TimeSpan?>]: The time to buffer before an appointment for this service can start.
  • [SchedulingPolicy <IMicrosoftGraphBookingSchedulingPolicy>]: This type represents the set of policies that dictate how bookings can be created in a Booking Calendar.
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [AllowStaffSelection <Boolean?>]: True if to allow customers to choose a specific person for the booking.
    • [MaximumAdvance <TimeSpan?>]: Maximum number of days in advance that a booking can be made. It follows the ISO 8601 format.
    • [MinimumLeadTime <TimeSpan?>]: The minimum amount of time before which bookings and cancellations must be made. It follows the ISO 8601 format.
    • [SendConfirmationsToOwner <Boolean?>]: True to notify the business via email when a booking is created or changed. Use the email address specified in the email property of the bookingBusiness entity for the business.
    • [TimeSlotInterval <TimeSpan?>]: Duration of each time slot, denoted in ISO 8601 format.
  • [SmsNotificationsEnabled <Boolean?>]: True indicates SMS notifications can be sent to the customers for the appointment of the service. Default value is false.
  • [StaffMemberIds <String- []>]: Represents those staff members who provide this service.

CUSTOMQUESTIONS <IMicrosoftGraphBookingQuestionAssignment- []>: Contains the set of custom questions associated with a particular service.

  • [IsRequired <Boolean?>]: The ID of the custom question.
  • [QuestionId <String>]: Indicates whether it's mandatory to answer the custom question.

DEFAULTLOCATION <IMicrosoftGraphLocation>: location

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Address <IMicrosoftGraphPhysicalAddress>]: physicalAddress
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [City <String>]: The city.
    • [CountryOrRegion <String>]: The country or region. It's a free-format string value, for example, 'United States'.
    • [PostalCode <String>]: The postal code.
    • [State <String>]: The state.
    • [Street <String>]: The street.
  • [Coordinates <IMicrosoftGraphOutlookGeoCoordinates>]: outlookGeoCoordinates
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Accuracy <Double?>]: The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters.
    • [Altitude <Double?>]: The altitude of the location.
    • [AltitudeAccuracy <Double?>]: The accuracy of the altitude.
    • [Latitude <Double?>]: The latitude of the location.
    • [Longitude <Double?>]: The longitude of the location.
  • [DisplayName <String>]: The name associated with the location.
  • [LocationEmailAddress <String>]: Optional email address of the location.
  • [LocationType <String>]: locationType
  • [LocationUri <String>]: Optional URI representing the location.
  • [UniqueId <String>]: For internal use only.
  • [UniqueIdType <String>]: locationUniqueIdType

DEFAULTREMINDERS <IMicrosoftGraphBookingReminder- []>: 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.

  • [Message <String>]: The message in the reminder.
  • [Offset <TimeSpan?>]: The amount of time before the start of an appointment that the reminder should be sent. It's denoted in ISO 8601 format.
  • [Recipients <String>]: bookingReminderRecipients

INPUTOBJECT <IBookingsIdentity>: Identity Parameter

  • [AttendanceRecordId <String>]: The unique identifier of attendanceRecord
  • [BookingAppointmentId <String>]: The unique identifier of bookingAppointment
  • [BookingBusinessId <String>]: The unique identifier of bookingBusiness
  • [BookingCurrencyId <String>]: The unique identifier of bookingCurrency
  • [BookingCustomQuestionId <String>]: The unique identifier of bookingCustomQuestion
  • [BookingCustomerBaseId <String>]: The unique identifier of bookingCustomerBase
  • [BookingServiceId <String>]: The unique identifier of bookingService
  • [BookingStaffMemberBaseId <String>]: The unique identifier of bookingStaffMemberBase
  • [MeetingAttendanceReportId <String>]: The unique identifier of meetingAttendanceReport
  • [Role <String>]: Usage: role='{role}'
  • [UserId <String>]: Usage: userId='{userId}'
  • [VirtualEventId <String>]: The unique identifier of virtualEvent
  • [VirtualEventRegistrationId <String>]: The unique identifier of virtualEventRegistration
  • [VirtualEventSessionId <String>]: The unique identifier of virtualEventSession
  • [VirtualEventWebinarId <String>]: The unique identifier of virtualEventWebinar

SCHEDULINGPOLICY <IMicrosoftGraphBookingSchedulingPolicy>: This type represents the set of policies that dictate how bookings can be created in a Booking Calendar.

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [AllowStaffSelection <Boolean?>]: True if to allow customers to choose a specific person for the booking.
  • [MaximumAdvance <TimeSpan?>]: Maximum number of days in advance that a booking can be made. It follows the ISO 8601 format.
  • [MinimumLeadTime <TimeSpan?>]: The minimum amount of time before which bookings and cancellations must be made. It follows the ISO 8601 format.
  • [SendConfirmationsToOwner <Boolean?>]: True to notify the business via email when a booking is created or changed. Use the email address specified in the email property of the bookingBusiness entity for the business.
  • [TimeSlotInterval <TimeSpan?>]: Duration of each time slot, denoted in ISO 8601 format.

https://learn.microsoft.com/powershell/module/microsoft.graph.bookings/update-mgbookingbusinessservice

https://learn.microsoft.com/graph/api/bookingservice-update?view=graph-rest-1.0