View as Markdown
Microsoft Bookings icon

Microsoft Bookings ACTION

Create Appointment

Creates a new appointment in a Microsoft Bookings business. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Microsoft Bookings account once, then configure and run Create Appointment from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "microsoft_bookings-create-appointment",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    microsoft_bookings: { authProvisionId: "apn_xxxxxxx" },
    businessId: "Business",
    serviceId: "Service",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Appointment inputs
Property Type Description
businessId Business string
Select a booking business
Required Dynamic
serviceId Service string
Select a service
Required Dynamic
customerId Customer ID string
Select an existing customer. Important: Customers must exist in the system before booking appointments.
Required Dynamic
customerName Customer Name string
The name of the customer
Optional
customerEmailAddress Customer Email Address string
The SMTP address of the customer
Optional
customerTimeZone Customer Time Zone string
The customer's time zone (e.g., America/Chicago, UTC)
Optional
startDateTime Start Date Time string
The date and time when the appointment begins in ISO 8601 format (e.g., 2024-05-01T12:00:00)
Required
endDateTime End Date Time string
The date and time when the appointment ends in ISO 8601 format (e.g., 2024-05-01T13:00:00)
Required
timeZone Time Zone string
The time zone for the appointment (e.g., UTC, America/Chicago)
Required
customerPhone Customer Phone string
The phone number of the customer
Optional
customerNotes Customer Notes string
Notes from the customer associated with this appointment
Optional
isLocationOnline Is Location Online boolean
True indicates that the appointment will be held online
Optional
staffMemberIds Staff Member IDs string[]
The IDs of each staff member who is scheduled in this appointment
Optional Dynamic
smsNotificationsEnabled SMS Notifications Enabled boolean
If SMS notifications will be sent to the customers for the appointment
Optional
price Price string
The regular price for the appointment
Optional
priceType Price Type string
The pricing structure for the appointment
Optional
duration Duration string
The length of the appointment in ISO 8601 format (e.g., PT1H for 1 hour, PT30M for 30 minutes). If not specified, calculated from start/end times.
Optional
maximumAttendeesCount Maximum Attendees Count integer
The maximum number of customers allowed in this appointment
Optional
preBuffer Pre-Buffer string
Time to reserve before the appointment in ISO 8601 format (e.g., PT15M for 15 minutes)
Optional
postBuffer Post-Buffer string
Time to reserve after the appointment in ISO 8601 format (e.g., PT15M for 15 minutes)
Optional
serviceNotes Service Notes string
Notes from the staff member about this appointment
Optional
additionalInformation Additional Information string
Additional information sent to the customer when the appointment is confirmed
Optional
isCustomerAllowedToManageBooking Customer Can Manage Booking boolean
Indicates that the customer can manage bookings created by the staff
Optional
optOutOfCustomerEmail Opt Out of Customer Email boolean
If true, the customer doesn't wish to receive a confirmation for this appointment
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
microsoft_bookings-create-appointment
Version
0.0.1
App
Microsoft Bookings
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes