View as Markdown
Mindbody icon

Mindbody ACTION

Book Appointment

Books a client into a one-on-one service appointment (personal training, massage, etc.). All five core parameters are required: clientId, locationId, sessionTypeId, startDateTime, and staffId. Use Search Clients to find the client ID, List Session Types to find sessionTypeId, and List Staff to find staffId. startDateTime format: ISO 8601 YYYY-MM-DDTHH:MM:SS (e.g., 2026-07-15T10:00:00). Location IDs are returned by Get Site Info. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Mindbody account once, then configure and run Book 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: "mindbody-book-appointment",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mindbody: { authProvisionId: "apn_xxxxxxx" },
    clientId: "Client ID",
    locationId: 10,
  },
})

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.

Book Appointment inputs
Property Type Description
clientId Client ID string
The client to book the appointment for. Use Search Clients to find the ID.
Required
locationId Location ID integer
The studio location where the appointment will take place. Location IDs are returned by Get Site Info.
Required
sessionTypeId Session Type ID integer
The type of service to book (e.g., personal training, massage). Use List Session Types to find valid IDs.
Required
startDateTime Start Date/Time string
When the appointment starts. ISO 8601 format: YYYY-MM-DDTHH:MM:SS (e.g., 2026-07-15T10:00:00).
Required
staffId Staff ID string
The staff member (instructor/therapist) who will deliver the service. Staff member must be an instructor for the requested service. Use List Staff to find IDs.
Required
notes Notes string
Optional notes to attach to the 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
mindbody-book-appointment
Version
0.0.3
App
Mindbody
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes