Skip to main content
Microsoft Bookings logo
  • Category: scheduling & booking
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 35
  • Triggers: 0
  • Slug: MICROSOFT_BOOKINGS
  • Version: 20261101_00

Tools

Slug: MICROSOFT_BOOKINGS_CANCEL_APPOINTMENTIrreversibly cancel an appointment and ask Microsoft Bookings to send the supplied cancellation message to its customers and staff. A successful result confirms that Graph accepted the cancellation, not message delivery.

Input Parameters

string
required
ID of the booking business that owns the appointment.
string
required
ID of the appointment to cancel.
string
required
Message sent to the appointment’s customers and staff explaining the cancellation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_CREATE_APPOINTMENTCreate an appointment for a service at explicit start and end times, optionally assigning staff and customer details. Microsoft Bookings may send customers a confirmation email; opt_out_of_customer_email requests suppression but does not guarantee non-delivery.

Input Parameters

number
Appointment price.
array
Customers attached to the appointment.
array
Reminder messages and offsets for the appointment.
string
ISO 8601 setup duration before the appointment.
string ("undefined" | "fixedPrice" | "startingAt" | "hourly" | "free" | "priceVaries" | "callUs" | "notSet" | "unknownFutureValue")
How the appointment price is interpreted.
string
required
ID of the service being booked.
string
required
ID of the booking business that owns the appointment.
string
ISO 8601 cleanup duration after the appointment.
object
required
Appointment end with its interpretation time zone; it must be later than the start.
string
Service notes stored on this appointment.
object
required
Appointment start with its interpretation time zone.
object
Location for this appointment.
array
IDs of staff assigned to the appointment.
string
Label used to categorize the appointment.
string
Customer’s Windows time-zone name.
boolean
Whether this is an online appointment.
string
Information included with the appointment.
integer
required
Maximum attendees allowed; use more than one for multi-customer appointments.
boolean
Ask Microsoft Bookings not to send the customer confirmation email. This preference does not guarantee that no email is delivered.
boolean
Whether SMS notifications are enabled when the service supports them.
boolean
Whether customers may manage this booking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_CREATE_BOOKING_BUSINESSCreate a shared booking business with the supplied display name. The business starts unpublished and can then be configured with the update tool.

Input Parameters

string
required
Customer-facing name for the new booking business.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_CREATE_CUSTOMERCreate a saved customer in one booking business with structured contact details.

Input Parameters

array
Customer telephone numbers with typed labels.
array
Customer postal addresses.
string
required
ID of the booking business that will own the customer.
string
required
Customer’s display name.
string
Customer’s email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_CREATE_CUSTOM_QUESTIONCreate a text or single-choice intake question for one booking business.

Input Parameters

string
required
ID of the booking business that will own the custom question.
string
required
Question text shown to customers.
array
Allowed choices for a radioButton question.
string ("text" | "radioButton" | "unknownFutureValue")
Expected answer type; radioButton uses answer_options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_CREATE_SERVICECreate a bookable service with a name and default duration, optionally configuring location, price, staff, reminders, questions, and scheduling rules.

Input Parameters

string
Internal service notes.
string
Default ISO 8601 setup duration.
string
required
ID of the booking business that will offer the service.
string
Customer-facing service description.
string
Default ISO 8601 cleanup duration.
string
required
Customer-facing service name.
string
BCP 47 language tag for the service.
number
Default numeric service price.
array
Custom questions assigned to this service and whether each is required.
string
required
Default appointment length as an ISO 8601 duration, for example PT30M.
object
Default service location.
array
Staff IDs eligible to deliver the service.
array
Default reminders copied to new appointments.
object
Service-specific scheduling policy.
string ("undefined" | "fixedPrice" | "startingAt" | "hourly" | "free" | "priceVaries" | "callUs" | "notSet")
How the default service price is interpreted.
boolean
Whether this is an online service.
string
Additional service information sent with bookings.
integer
Maximum attendees for appointments of this service.
boolean
Whether the service is hidden from customers.
boolean
Whether anonymous online-meeting join is enabled.
boolean
Whether SMS notifications are enabled when supported.
boolean
Whether customers may manage bookings for this service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_CREATE_STAFF_MEMBERAdd a staff member to one booking business with a role, email, time zone, and optional working schedule.

Input Parameters

string ("guest" | "administrator" | "viewer" | "externalGuest" | "scheduler")
required
Bookings role granted to the staff member.
string
Staff member’s Windows time-zone name.
string
required
ID of the booking business that will contain the staff member.
string
required
Staff member’s display name.
string
required
Staff member’s email address.
array
Weekly working schedule used when use_business_hours is false.
boolean
Whether this staff member follows the business-wide hours.
boolean
Whether the staff member receives booking email notifications.
boolean
Whether personal calendar events affect Bookings availability.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_DELETE_APPOINTMENTPermanently delete an appointment without invoking Microsoft Bookings’ cancellation-message action. This operation cannot be undone.

Input Parameters

string
required
ID of the booking business that owns the appointment.
string
required
ID of the appointment to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_DELETE_BOOKING_BUSINESSPermanently delete one shared booking business and all of its Microsoft Bookings data. This operation cannot be undone.

Input Parameters

string
required
ID of the booking business to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_DELETE_CUSTOMERPermanently delete one saved customer from a Microsoft Bookings business. This operation cannot be undone.

Input Parameters

string
required
ID of the booking business that owns the customer.
string
required
ID of the saved customer to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_DELETE_CUSTOM_QUESTIONPermanently delete one custom intake question from a booking business. This operation cannot be undone.

Input Parameters

string
required
ID of the booking business that owns the question.
string
required
ID of the custom question to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_DELETE_SERVICEPermanently delete one service from a Microsoft Bookings business. This operation cannot be undone.

Input Parameters

string
required
ID of the service to permanently delete.
string
required
ID of the booking business that offers the service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_DELETE_STAFF_MEMBERPermanently remove one staff member from a Microsoft Bookings business. This operation cannot be undone.

Input Parameters

string
required
ID of the staff member to permanently remove.
string
required
ID of the booking business that contains the staff member.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_GET_APPOINTMENTGet one booking appointment, including its service, customers, assigned staff, attendee counts, and UTC start and end times.

Input Parameters

array
Expansion expressions to pass to Microsoft Graph as comma-separated $expand. Graph may reject relations unsupported by this resource.
string
required
ID of the booking business that owns the appointment.
boolean
Pass Microsoft Graph’s documented $count option on this request. Graph may reject this option for a single-resource route.
string
required
ID of the appointment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_GET_BOOKING_BUSINESSGet the complete configuration and publication state of one shared booking business.

Input Parameters

string
required
Booking business ID, commonly the business SMTP address; obtain it from List or Create Booking Businesses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_GET_CURRENCYGet one Microsoft Bookings currency by its ISO currency code.

Input Parameters

array
Expansion expressions to pass to Microsoft Graph as comma-separated $expand. Graph may reject relations unsupported by this resource.
string
required
Three-letter ISO 4217 currency code, for example USD.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_GET_CUSTOMERGet one saved customer and their contact details from a booking business.

Input Parameters

array
Expansion expressions to pass to Microsoft Graph as comma-separated $expand. Graph may reject relations unsupported by this resource.
string
required
ID of the booking business that owns the customer.
string
required
Opaque Base64-encoded ID of the saved customer to retrieve. IDs returned by Microsoft Graph create or list operations are already in Graph’s usable encoded form; pass the returned id unchanged and do not encode it again.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_GET_CUSTOM_QUESTIONGet one custom intake question, including its answer type and available choices.

Input Parameters

array
Expansion expressions to pass to Microsoft Graph as comma-separated $expand. Graph may reject relations unsupported by this resource.
string
required
ID of the booking business that owns the custom question.
string
required
ID of the custom question to retrieve.
boolean
Pass Microsoft Graph’s documented $count option on this request. Graph may reject this option for a single-resource route.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_GET_SERVICEGet one service and its duration, pricing, staff, questions, reminders, location, and scheduling configuration.

Input Parameters

array
Expansion expressions to pass to Microsoft Graph as comma-separated $expand. Graph may reject relations unsupported by this resource.
string
required
ID of the service to retrieve.
string
required
ID of the booking business that offers the service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_GET_STAFF_MEMBERGet one booking staff member’s identity, role, membership state, time zone, working hours, and calendar settings.

Input Parameters

array
Expansion expressions to pass to Microsoft Graph as comma-separated $expand. Graph may reject relations unsupported by this resource.
string
required
ID of the staff member to retrieve.
string
required
ID of the booking business that contains the staff member.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_LIST_APPOINTMENTSList one Microsoft Graph page of appointments for a booking business. Omit start and end to list the appointments collection, or provide both to list appointments occurring in that inclusive calendar-view range.

Input Parameters

string
Inclusive range end as an ISO 8601 date-time with an explicit UTC offset or Z. Provide start and end together to use calendar view.
string
Inclusive range start as an ISO 8601 date-time with an explicit UTC offset or Z. Provide start and end together to use calendar view.
array
Expansion expressions to pass to Microsoft Graph as comma-separated $expand on either appointments route. Graph may reject unsupported relations.
string
required
ID of the booking business whose appointments to list.
string
Opaque cursor from a previous response. Omit it for the first page, then pass it back unchanged to fetch the next page.
boolean
Include the total appointment count when Microsoft Graph provides it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_LIST_BOOKING_BUSINESSESList shared booking businesses visible to the connected work or school account. Microsoft Graph returns up to 500 results and does not paginate this endpoint. Results contain only each business ID and display name; use search_query to narrow results or Get Booking Business for full details.

Input Parameters

string
Return only booking businesses matching this search text.
boolean
Include the total matching count when Microsoft Graph provides it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_LIST_CURRENCIESReturn one Microsoft Graph page of the Microsoft Bookings currency catalog with ISO currency IDs and localized symbols. The documented OData controls are passed through, but Graph may accept and ignore them.

Input Parameters

integer
Non-negative $top value to pass through. Graph may accept this option without limiting the returned catalog page.
integer
Non-negative $skip value to pass through. Graph may accept this option without changing the returned catalog page.
array
Expansion expressions to pass as comma-separated $expand. Graph may ignore or reject relations unsupported by booking currencies.
string
OData filter expression to pass through as $filter. Graph may accept this option without filtering the currency catalog.
array
Currency properties to pass as comma-separated $select. Graph may accept this option without projecting the response.
string
Opaque cursor from a previous response. Omit it for the first page, then pass it back unchanged to fetch the next page.
boolean
Pass the documented $count option to Microsoft Graph. The provider may accept it without returning @odata.count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_LIST_CUSTOMERSList saved customers for one booking business, one Microsoft Graph page at a time.

Input Parameters

array
Expansion expressions to pass to Microsoft Graph as comma-separated $expand. Graph may reject relations unsupported by booking customers.
string
required
ID of the booking business whose customers to list.
string
Opaque cursor from a previous response. Omit it for the first page, then pass it back unchanged to fetch the next page.
boolean
Include the total customer count when Microsoft Graph provides it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_LIST_CUSTOM_QUESTIONSList custom intake questions defined for one booking business, one Microsoft Graph page at a time.

Input Parameters

array
Expansion expressions to pass to Microsoft Graph as comma-separated $expand. Graph may reject relations unsupported by custom questions.
string
required
ID of the booking business whose custom questions to list.
string
Opaque cursor from a previous response. Omit it for the first page, then pass it back unchanged to fetch the next page.
boolean
Include the total question count when Microsoft Graph provides it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_LIST_SERVICESList services offered by one booking business, including duration, pricing, staff, and scheduling defaults, one Microsoft Graph page at a time.

Input Parameters

array
Expansion expressions to pass to Microsoft Graph as comma-separated $expand. Graph may reject relations unsupported by booking services.
string
required
ID of the booking business whose services to list.
string
Opaque cursor from a previous response. Omit it for the first page, then pass it back unchanged to fetch the next page.
boolean
Include the total service count when Microsoft Graph provides it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_LIST_STAFF_MEMBERSList staff members configured for one booking business, including roles and working hours, one Microsoft Graph page at a time.

Input Parameters

array
Expansion expressions to pass to Microsoft Graph as comma-separated $expand. Graph may reject relations unsupported by booking staff.
string
required
ID of the booking business whose staff to list.
string
Opaque cursor from a previous response. Omit it for the first page, then pass it back unchanged to fetch the next page.
boolean
Include the total staff count when Microsoft Graph provides it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_PUBLISH_BOOKING_BUSINESSPublish a booking business’s external scheduling page so customers can access it. After publishing, call Get Booking Business to retrieve the resulting public URL.

Input Parameters

string
required
ID of the configured booking business to publish.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_UNPUBLISH_BOOKING_BUSINESSTake a booking business’s external scheduling page offline and clear its public URL without deleting the business.

Input Parameters

string
required
ID of the published booking business to take offline.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_UPDATE_APPOINTMENTUpdate an existing appointment’s schedule, customers, service, staff, location, notifications, or pricing without cancelling it. The request requires filled and maximum attendee counts plus at least one other appointment field to update.

Input Parameters

number
Replacement appointment price.
array
Complete replacement customer information; omit customer notes.
array
Complete replacement reminder list.
string
Replacement ISO 8601 setup duration.
string ("undefined" | "fixedPrice" | "startingAt" | "hourly" | "free" | "priceVaries" | "callUs" | "notSet" | "unknownFutureValue")
Replacement interpretation of the appointment price.
string
Replacement service ID.
string
required
ID of the booking business that owns the appointment.
string
Replacement ISO 8601 cleanup duration.
object
Replacement end date, time, and time zone.
string
Replacement service notes.
string
required
ID of the appointment to update.
object
Replacement start date, time, and time zone.
object
Replacement appointment location.
array
Complete replacement list of assigned staff IDs.
string
Replacement appointment label.
string
Customer’s Windows time-zone name.
boolean
Whether the appointment is online.
string
Replacement additional appointment information.
integer
required
Current or desired filled attendee count; repeat the value from Get Appointment when unchanged.
integer
required
Current or desired maximum attendee count; repeat the value from Get Appointment when unchanged.
boolean
Whether customer email is suppressed.
boolean
Whether SMS notifications are enabled when supported.
boolean
Whether customers may manage the booking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_UPDATE_BOOKING_BUSINESSUpdate supported contact details, hours, currency, business type, address, or scheduling rules without publishing or unpublishing the business.

Input Parameters

string
Business contact telephone number.
object
Structured postal address for the business.
string
required
ID of the booking business to update.
string
Business website URL.
string
Business category label. Microsoft documents this field as updateable, but Graph can accept the PATCH without persisting it; read the business afterward when the resulting value matters.
array
Complete weekly business-hours schedule.
object
Business-wide booking lead-time, interval, and staff-selection rules.
string
Three-letter ISO currency code supported by Bookings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_UPDATE_CUSTOMERUpdate a saved customer’s name, email, phone numbers, or postal addresses in one booking business.

Input Parameters

array
Complete replacement list of customer telephone numbers.
array
Complete replacement list of customer postal addresses.
string
required
ID of the booking business that owns the customer.
string
required
ID of the saved customer to update.
string
Replacement customer display name.
string
Replacement customer email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_UPDATE_CUSTOM_QUESTIONUpdate the text of one custom intake question, optionally changing its answer type or choices.

Input Parameters

string
required
ID of the booking business that owns the question.
string
required
ID of the custom question to update.
string
required
Replacement question text. Microsoft Graph documents this field as required.
array
Complete replacement choices for a radioButton question.
string ("text" | "radioButton" | "unknownFutureValue")
Replacement answer type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_UPDATE_SERVICEUpdate a service’s name, duration, location, pricing, staff, reminders, questions, visibility, or scheduling rules.

Input Parameters

string
Replacement internal notes.
string
Replacement default ISO 8601 setup duration.
string
required
ID of the service to update.
string
required
ID of the booking business that offers the service.
string
Replacement customer-facing description.
string
Replacement default ISO 8601 cleanup duration.
string
Replacement customer-facing service name.
string
Replacement BCP 47 language tag.
number
Replacement default price.
array
Complete replacement question assignment list.
string
Replacement default ISO 8601 appointment duration.
object
Replacement default location.
array
Complete replacement list of eligible staff IDs.
array
Complete replacement default-reminder list.
object
Replacement service-specific scheduling policy.
string ("undefined" | "fixedPrice" | "startingAt" | "hourly" | "free" | "priceVaries" | "callUs" | "notSet")
Replacement price interpretation.
boolean
Whether this is an online service.
string
Replacement additional service information.
integer
Replacement maximum attendee count.
boolean
Whether this service is hidden from customers.
boolean
Whether anonymous online-meeting join is enabled.
boolean
Whether SMS notifications are enabled when supported.
boolean
Whether customers may manage bookings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MICROSOFT_BOOKINGS_UPDATE_STAFF_MEMBERUpdate a booking staff member’s identity, role, time zone, working schedule, calendar behavior, or email notifications.

Input Parameters

string ("guest" | "administrator" | "viewer" | "externalGuest" | "scheduler")
Replacement Bookings role.
string
required
ID of the staff member to update.
string
Replacement Windows time-zone name.
string
required
ID of the booking business that contains the staff member.
string
Replacement staff display name.
string
Replacement staff email address.
array
Complete replacement weekly working schedule.
boolean
Whether this staff member follows business-wide hours.
boolean
Whether the staff member receives booking email notifications.
boolean
Whether personal calendar events affect Bookings availability.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not