Mindbody
App · 20 actions
Run your Mindbody studio from workflows: find and add clients, book them into classes and appointments, read staff, locations, pricing options and sales, and start a workflow when a client joins, a sale is made or an appointment is booked.
Actions
| Action | What it does |
|---|---|
| Add client | Add a new client to the business. |
| Book appointment | Book an appointment for a client with a staff member at a location. |
| Book client into class | Book a client into a class, or onto its waiting list. |
| Cancel appointment | Cancel an appointment, on time or as a late cancellation. |
| Find open appointment times | Find when staff are free to take a type of appointment, between two days. |
| Get class roster | Get a class with everyone booked into it and whether they have signed in. |
| Get client | Get one client's details: contact details, status, balance and home location. |
| List appointments | List booked appointments between two days, for everyone or one staff member, location or client. |
| List classes | List scheduled classes between two days, with their teacher, location and how full they are. |
| List client visits | List a client's class and appointment visits between two days, past or booked. |
| List clients | Find clients by name or email, or list those changed since a time. |
| List locations | List the business's locations, with their addresses. |
| List pricing options | List the passes, memberships and drop-ins the business sells, with their prices. |
| List sales | List sales made between two times, with what was bought and how it was paid. |
| List service categories | List the business's service categories (Mindbody calls them programs), such as Yoga classes or Massage appointments. |
| List session types | List the kinds of class and appointment the business offers, with their usual length. |
| List staff | List the business's staff members. |
| Remove client from class | Cancel a client's booking in a class. |
| Update appointment | Move an appointment, change who it's with or its notes, or mark it confirmed, arrived or completed. |
| Update client | Change a client's details, or make them active or inactive. |
Add client
Add a new client to the business. Mindbody refuses a second client with the same first name, last name and email.
Inputs
- First name
first_nametextRequired - The client's first name.
- Last name
last_nametextRequired - The client's last name.
- Email
emailtext - The client's email address.
- Mobile phone
mobile_phonetext - The client's mobile number.
- Birthday
birth_datedate - The client's date of birth.
- Street address
address_line_1text - The first address line.
- City
citytext - The client's city.
- State or province
statetext - The client's state.
- Postal code
postal_codetext - The client's postal code.
- Staff notes
notestext - Notes for staff on the client's account; clients don't see them.
- Prospect
is_prospecttrue/false - Mark the client as a prospect (a lead who hasn't bought yet).
- Home location
home_location_idtext - The location the client mostly visits.
- Account emails
send_account_emailstrue/false - Whether the client receives Mindbody's account emails.
Outputs
clientobject- The client
Example output
{
"client": {
"AccountBalance": 0,
"Active": true,
"AddressLine1": "1 Elm St",
"BirthDate": "1990-04-01T00:00:00",
"City": "San Luis Obispo",
"Country": "US",
"CreationDate": "2026-11-05T10:12:00",
"Email": "jo@example.com",
"FirstName": "Jo",
"HomeLocation": {
"Address": "100 Main St",
"Address2": "",
"City": "San Luis Obispo",
"Description": "Our main studio",
"HasClasses": true,
"Id": 1,
"Name": "Downtown Studio",
"Phone": "8055550100",
"PostalCode": "93401",
"SiteId": -99,
"StateProvCode": "CA"
},
"HomePhone": "",
"Id": "100015678",
"IsProspect": false,
"LastModifiedDateTime": "2026-11-05T10:12:00",
"LastName": "Bloggs",
"MobilePhone": "8055550123",
"Notes": "",
"PostalCode": "93401",
"State": "CA",
"Status": "Non-Member",
"UniqueId": 100015678
}
}Book appointment
Book an appointment for a client with a staff member at a location.
Inputs
- Client ID
client_idtextRequired - The client's ID in Mindbody, from 'List clients' or an earlier step.
- Location
location_idtextRequired - Where the appointment is.
- Staff member
staff_idtextRequired - Who the appointment is with.
- Session type
session_type_idtextRequired - The kind of appointment, such as a 60-minute massage.
- Start
start_date_timedate and timeRequired - When the appointment starts.
- End
end_date_timedate and time - When it ends. Leave empty for the session type's usual length.
- Notes
notestext - Notes on the appointment.
- Staff requested
staff_requestedtrue/false - The client asked for this staff member by name.
- Send email
send_emailtrue/false - Send the client Mindbody's automatic email for this, if the business has it set up. Off unless you turn it on.
- Use a pricing option
apply_paymenttrue/false - Pay with a pricing option the client owns. Mindbody does this unless you turn it off.
Outputs
appointmentobject- The appointment
Example output
{
"appointment": {
"ClientId": "100015678",
"Duration": 60,
"EndDateTime": "2026-11-10T15:00:00",
"FirstAppointment": true,
"GenderPreference": "None",
"Id": 51234,
"LocationId": 1,
"Notes": "",
"ProgramId": 22,
"SessionTypeId": 5,
"StaffId": 100000279,
"StaffRequested": false,
"StartDateTime": "2026-11-10T14:00:00",
"Status": "Booked"
}
}Book client into class
Book a client into a class, or onto its waiting list.
Inputs
- Client ID
client_idtextRequired - The client's ID in Mindbody, from 'List clients' or an earlier step.
- Class ID
class_idtextRequired - The class's ID, from 'List classes' or an earlier step.
- Require payment
require_paymenttrue/false - Only book if the client has a pricing option that pays for it.
- Waiting list
waitlisttrue/false - Add the client to the waiting list.
- Send email
send_emailtrue/false - Send the client Mindbody's automatic email for this, if the business has it set up. Off unless you turn it on.
- Pricing option to use
client_service_idtext - The ID of a pricing option the client owns to pay for this.
Outputs
visitobject- The booking
Example output
{
"visit": {
"AppointmentId": 0,
"ClassId": 3300,
"ClientId": "100015678",
"EndDateTime": "2026-11-07T09:00:00",
"Id": 9001,
"LastModifiedDateTime": "2026-11-05T10:20:00",
"LateCancelled": false,
"LocationId": 1,
"Missed": false,
"Name": "Morning Flow",
"ServiceName": "10 class pass",
"SignedIn": false,
"StaffId": 100000279,
"StartDateTime": "2026-11-07T08:00:00",
"WebSignup": false
}
}Cancel appointment
Cancel an appointment, on time or as a late cancellation.
Inputs
- Appointment ID
appointment_idtextRequired - The appointment's ID, from 'List appointments' or an earlier step.
- Late cancel
late_canceltrue/false - Record it as a late cancellation (the business's late-cancel rules apply).
- Send email
send_emailtrue/false - Send the client Mindbody's automatic email for this, if the business has it set up. Off unless you turn it on.
Outputs
appointmentobject- The appointment
Example output
{
"appointment": {
"ClientId": "100015678",
"Duration": 60,
"EndDateTime": "2026-11-10T15:00:00",
"FirstAppointment": true,
"GenderPreference": "None",
"Id": 51234,
"LocationId": 1,
"Notes": "",
"ProgramId": 22,
"SessionTypeId": 5,
"StaffId": 100000279,
"StaffRequested": false,
"StartDateTime": "2026-11-10T14:00:00",
"Status": "Cancelled"
}
}Find open appointment times
Find when staff are free to take a type of appointment, between two days. Times are the business's local time.
Inputs
- Session type
session_type_idtextRequired - The kind of appointment, such as a 60-minute massage.
- From
start_datedate - The first day to look. Defaults to today.
- To
end_datedate - The last day to look. Defaults to the first.
- Location
location_idtext - Only this location.
- Staff member
staff_idtext - Only this staff member.
- How many
limitnumber - How many to return, 1 to 200. Mindbody's default is 100.From 1 to 200.
- Skip
offsetnumber - How many to skip, to get the next page. Starts at 0.At least 0.
Outputs
availabilitieslist- The open times
countnumber- How many came back in this page
offsetnumber- How many were skipped
totalnumber- How many there are in all
Example output
{
"availabilities": [
{
"BookableEndDateTime": "2026-11-10T16:00:00",
"EndDateTime": "2026-11-10T17:00:00",
"Id": 812,
"Location": {
"Address": "100 Main St",
"Address2": "",
"City": "San Luis Obispo",
"Description": "Our main studio",
"HasClasses": true,
"Id": 1,
"Name": "Downtown Studio",
"Phone": "8055550100",
"PostalCode": "93401",
"SiteId": -99,
"StateProvCode": "CA"
},
"SessionType": {
"Category": "Massage",
"CategoryId": 3,
"DefaultTimeLength": 60,
"Id": 5,
"Name": "60-minute massage",
"NumDeducted": 1,
"OnlineDescription": "",
"ProgramId": 22,
"Type": "Appointment"
},
"Staff": {
"AppointmentInstructor": true,
"Bio": "",
"ClassTeacher": true,
"DisplayName": "Ashley",
"Email": "ashley@example.com",
"FirstName": "Ashley",
"Id": 100000279,
"ImageUrl": "",
"IndependentContractor": false,
"LastName": "Knight",
"MobilePhone": "8055550101",
"Name": "Ashley Knight"
},
"StartDateTime": "2026-11-10T09:00:00"
}
],
"count": 1,
"offset": 0,
"total": 1
}Get class roster
Get a class with everyone booked into it and whether they have signed in.
Inputs
- Class ID
class_idtextRequired - The class's ID, from 'List classes' or an earlier step.
Outputs
classobject- The class
countnumber- How many are booked in
visitslist- Who is booked in
Example output
{
"class": {
"ClassDescription": {
"Category": "Yoga",
"Description": "An easy-going vinyasa class.",
"Id": 77,
"Name": "Morning Flow",
"Program": {
"CancelOffset": 12,
"Id": 21,
"Name": "Yoga",
"ScheduleType": "Class"
},
"SessionType": {
"Category": "Massage",
"CategoryId": 3,
"DefaultTimeLength": 60,
"Id": 6,
"Name": "Yoga",
"NumDeducted": 1,
"OnlineDescription": "",
"ProgramId": 22,
"Type": "Class"
}
},
"ClassNotes": "",
"ClassScheduleId": 410,
"EndDateTime": "2026-11-07T09:00:00",
"Id": 3300,
"IsAvailable": true,
"IsCanceled": false,
"IsWaitlistAvailable": false,
"LastModifiedDateTime": "2026-11-01T09:00:00",
"Location": {
"Address": "100 Main St",
"Address2": "",
"City": "San Luis Obispo",
"Description": "Our main studio",
"HasClasses": true,
"Id": 1,
"Name": "Downtown Studio",
"Phone": "8055550100",
"PostalCode": "93401",
"SiteId": -99,
"StateProvCode": "CA"
},
"MaxCapacity": 20,
"Staff": {
"AppointmentInstructor": true,
"Bio": "",
"ClassTeacher": true,
"DisplayName": "Ashley",
"Email": "ashley@example.com",
"FirstName": "Ashley",
"Id": 100000279,
"ImageUrl": "",
"IndependentContractor": false,
"LastName": "Knight",
"MobilePhone": "8055550101",
"Name": "Ashley Knight"
},
"StartDateTime": "2026-11-07T08:00:00",
"Substitute": false,
"TotalBooked": 8,
"TotalBookedWaitlist": 0,
"TotalSignedIn": 0,
"VirtualStreamLink": "",
"WebBooked": 5,
"WebCapacity": 15
},
"count": 1,
"visits": [
{
"AppointmentId": 0,
"ClassId": 3300,
"ClientId": "100015678",
"EndDateTime": "2026-11-07T09:00:00",
"Id": 9001,
"LastModifiedDateTime": "2026-11-05T10:20:00",
"LateCancelled": false,
"LocationId": 1,
"Missed": false,
"Name": "Morning Flow",
"ServiceName": "10 class pass",
"SignedIn": false,
"StaffId": 100000279,
"StartDateTime": "2026-11-07T08:00:00",
"WebSignup": false
}
]
}Get client
Get one client's details: contact details, status, balance and home location.
Inputs
- Client ID
client_idtextRequired - The client's ID in Mindbody, from 'List clients' or an earlier step.
Outputs
clientobject- The client
Example output
{
"client": {
"AccountBalance": 0,
"Active": true,
"AddressLine1": "1 Elm St",
"BirthDate": "1990-04-01T00:00:00",
"City": "San Luis Obispo",
"Country": "US",
"CreationDate": "2026-11-05T10:12:00",
"Email": "jo@example.com",
"FirstName": "Jo",
"HomeLocation": {
"Address": "100 Main St",
"Address2": "",
"City": "San Luis Obispo",
"Description": "Our main studio",
"HasClasses": true,
"Id": 1,
"Name": "Downtown Studio",
"Phone": "8055550100",
"PostalCode": "93401",
"SiteId": -99,
"StateProvCode": "CA"
},
"HomePhone": "",
"Id": "100015678",
"IsProspect": false,
"LastModifiedDateTime": "2026-11-05T10:12:00",
"LastName": "Bloggs",
"MobilePhone": "8055550123",
"Notes": "",
"PostalCode": "93401",
"State": "CA",
"Status": "Non-Member",
"UniqueId": 100015678
}
}List appointments
List booked appointments between two days, for everyone or one staff member, location or client. Gets one page.
Inputs
- From
start_datedate - The first day to include. Defaults to today.
- To
end_datedate - The last day to include. Defaults to the first.
- Staff member
staff_idtext - Only this staff member.
- Location
location_idtext - Only this location.
- Client ID
client_idtext - Only this client's appointments.
- How many
limitnumber - How many to return, 1 to 200. Mindbody's default is 100.From 1 to 200.
- Skip
offsetnumber - How many to skip, to get the next page. Starts at 0.At least 0.
Outputs
appointmentslist- The appointments
countnumber- How many came back in this page
offsetnumber- How many were skipped
totalnumber- How many there are in all
Example output
{
"appointments": [
{
"ClientId": "100015678",
"Duration": 60,
"EndDateTime": "2026-11-10T15:00:00",
"FirstAppointment": true,
"GenderPreference": "None",
"Id": 51234,
"LocationId": 1,
"Notes": "",
"ProgramId": 22,
"SessionTypeId": 5,
"StaffId": 100000279,
"StaffRequested": false,
"StartDateTime": "2026-11-10T14:00:00",
"Status": "Booked"
}
],
"count": 1,
"offset": 0,
"total": 1
}List classes
List scheduled classes between two days, with their teacher, location and how full they are. Gets one page.
Inputs
- From
start_datedate - The first day to include. Defaults to today.
- To
end_datedate - The last day to include. Defaults to today.
- Location
location_idtext - Only this location.
- Staff member
staff_idtext - Only this staff member.
- Service category
program_idtext - Only this service category (Mindbody calls them programs).
- Hide canceled
hide_canceledtrue/false - Leave out canceled classes.
- How many
limitnumber - How many to return, 1 to 200. Mindbody's default is 100.From 1 to 200.
- Skip
offsetnumber - How many to skip, to get the next page. Starts at 0.At least 0.
Outputs
classeslist- The classes
countnumber- How many came back in this page
offsetnumber- How many were skipped
totalnumber- How many there are in all
Example output
{
"classes": [
{
"ClassDescription": {
"Category": "Yoga",
"Description": "An easy-going vinyasa class.",
"Id": 77,
"Name": "Morning Flow",
"Program": {
"CancelOffset": 12,
"Id": 21,
"Name": "Yoga",
"ScheduleType": "Class"
},
"SessionType": {
"Category": "Massage",
"CategoryId": 3,
"DefaultTimeLength": 60,
"Id": 6,
"Name": "Yoga",
"NumDeducted": 1,
"OnlineDescription": "",
"ProgramId": 22,
"Type": "Class"
}
},
"ClassNotes": "",
"ClassScheduleId": 410,
"EndDateTime": "2026-11-07T09:00:00",
"Id": 3300,
"IsAvailable": true,
"IsCanceled": false,
"IsWaitlistAvailable": false,
"LastModifiedDateTime": "2026-11-01T09:00:00",
"Location": {
"Address": "100 Main St",
"Address2": "",
"City": "San Luis Obispo",
"Description": "Our main studio",
"HasClasses": true,
"Id": 1,
"Name": "Downtown Studio",
"Phone": "8055550100",
"PostalCode": "93401",
"SiteId": -99,
"StateProvCode": "CA"
},
"MaxCapacity": 20,
"Staff": {
"AppointmentInstructor": true,
"Bio": "",
"ClassTeacher": true,
"DisplayName": "Ashley",
"Email": "ashley@example.com",
"FirstName": "Ashley",
"Id": 100000279,
"ImageUrl": "",
"IndependentContractor": false,
"LastName": "Knight",
"MobilePhone": "8055550101",
"Name": "Ashley Knight"
},
"StartDateTime": "2026-11-07T08:00:00",
"Substitute": false,
"TotalBooked": 8,
"TotalBookedWaitlist": 0,
"TotalSignedIn": 0,
"VirtualStreamLink": "",
"WebBooked": 5,
"WebCapacity": 15
}
],
"count": 1,
"offset": 0,
"total": 1
}List client visits
List a client's class and appointment visits between two days, past or booked. Gets one page.
Inputs
- Client ID
client_idtextRequired - The client's ID in Mindbody, from 'List clients' or an earlier step.
- From
start_datedate - The first day to include.
- To
end_datedate - The last day to include. Defaults to today.
- Unpaid only
unpaid_onlytrue/false - Only visits not yet paid for.
- Order
ordertext - Newest or oldest first.One of:
desc(Newest first),asc(Oldest first). - How many
limitnumber - How many to return, 1 to 200. Mindbody's default is 100.From 1 to 200.
- Skip
offsetnumber - How many to skip, to get the next page. Starts at 0.At least 0.
Outputs
countnumber- How many came back in this page
offsetnumber- How many were skipped
totalnumber- How many there are in all
visitslist- The visits
Example output
{
"count": 1,
"offset": 0,
"total": 1,
"visits": [
{
"AppointmentId": 0,
"ClassId": 3300,
"ClientId": "100015678",
"EndDateTime": "2026-11-07T09:00:00",
"Id": 9001,
"LastModifiedDateTime": "2026-11-05T10:20:00",
"LateCancelled": false,
"LocationId": 1,
"Missed": false,
"Name": "Morning Flow",
"ServiceName": "10 class pass",
"SignedIn": false,
"StaffId": 100000279,
"StartDateTime": "2026-11-07T08:00:00",
"WebSignup": false
}
]
}List clients
Find clients by name or email, or list those changed since a time. Gets one page; run it again with 'Skip' for more.
Inputs
- Search
search_texttext - A first name, last name or email to search for.
- Include inactive
include_inactivetrue/false - Include inactive clients too.
- Prospects only
is_prospecttrue/false - Only clients marked as prospects.
- Changed since
modified_sincedate and time - Only clients added or changed at or after this time.
- How many
limitnumber - How many to return, 1 to 200. Mindbody's default is 100.From 1 to 200.
- Skip
offsetnumber - How many to skip, to get the next page. Starts at 0.At least 0.
Outputs
clientslist- The clients found
countnumber- How many came back in this page
offsetnumber- How many were skipped
totalnumber- How many there are in all
Example output
{
"clients": [
{
"AccountBalance": 0,
"Active": true,
"AddressLine1": "1 Elm St",
"BirthDate": "1990-04-01T00:00:00",
"City": "San Luis Obispo",
"Country": "US",
"CreationDate": "2026-11-05T10:12:00",
"Email": "jo@example.com",
"FirstName": "Jo",
"HomeLocation": {
"Address": "100 Main St",
"Address2": "",
"City": "San Luis Obispo",
"Description": "Our main studio",
"HasClasses": true,
"Id": 1,
"Name": "Downtown Studio",
"Phone": "8055550100",
"PostalCode": "93401",
"SiteId": -99,
"StateProvCode": "CA"
},
"HomePhone": "",
"Id": "100015678",
"IsProspect": false,
"LastModifiedDateTime": "2026-11-05T10:12:00",
"LastName": "Bloggs",
"MobilePhone": "8055550123",
"Notes": "",
"PostalCode": "93401",
"State": "CA",
"Status": "Non-Member",
"UniqueId": 100015678
}
],
"count": 1,
"offset": 0,
"total": 1
}List locations
List the business's locations, with their addresses.
Inputs
None.
Outputs
countnumber- How many there are
locationslist- The locations
Example output
{
"count": 1,
"locations": [
{
"Address": "100 Main St",
"Address2": "",
"City": "San Luis Obispo",
"Description": "Our main studio",
"HasClasses": true,
"Id": 1,
"Name": "Downtown Studio",
"Phone": "8055550100",
"PostalCode": "93401",
"SiteId": -99,
"StateProvCode": "CA"
}
]
}List pricing options
List the passes, memberships and drop-ins the business sells, with their prices. Gets one page.
Inputs
- Service category
program_idtext - Only this service category (Mindbody calls them programs).
- Session type
session_type_idtext - Only pricing options that pay for this session type.
- Location for tax
location_idtext - Work out tax for this location. It doesn't narrow the list.
- Sold online
sell_onlinetrue/false - Only those sold online.
- Include discontinued
include_discontinuedtrue/false - Include pricing options no longer sold.
- How many
limitnumber - How many to return, 1 to 200. Mindbody's default is 100.From 1 to 200.
- Skip
offsetnumber - How many to skip, to get the next page. Starts at 0.At least 0.
Outputs
countnumber- How many came back in this page
offsetnumber- How many were skipped
serviceslist- The pricing options
totalnumber- How many there are in all
Example output
{
"count": 1,
"offset": 0,
"services": [
{
"Count": 10,
"Discontinued": false,
"ExpirationLength": 90,
"ExpirationUnit": "Days",
"Id": "1192",
"Name": "10 class pass",
"OnlinePrice": 140,
"Price": 150,
"ProductId": 1192,
"Program": "Yoga",
"ProgramId": 21,
"SellOnline": true,
"Type": "Series"
}
],
"total": 1
}List sales
List sales made between two times, with what was bought and how it was paid. Gets one page.
Inputs
- From
start_date_timedate and time - Sales made at or after this time.
- To
end_date_timedate and time - Sales made before this time.
- Sale ID
sale_idtext - Only this sale.
- Payment method ID
payment_method_idtext - Only sales paid this way.
- How many
limitnumber - How many to return, 1 to 200. Mindbody's default is 100.From 1 to 200.
- Skip
offsetnumber - How many to skip, to get the next page. Starts at 0.At least 0.
Outputs
countnumber- How many came back in this page
offsetnumber- How many were skipped
saleslist- The sales
totalnumber- How many there are in all
Example output
{
"count": 1,
"offset": 0,
"sales": [
{
"ClientId": "100015678",
"Id": 96,
"LocationId": 1,
"Payments": [
{
"Amount": 150,
"Id": 103,
"Method": 14,
"Notes": "",
"Type": "Cash"
}
],
"PurchasedItems": [
{
"Description": "10 class pass",
"DiscountAmount": 0,
"Id": 1192,
"IsService": true,
"Quantity": 1,
"Returned": false,
"TaxAmount": 0,
"TotalAmount": 150,
"UnitPrice": 150
}
],
"SaleDateTime": "2026-11-05T16:52:23",
"SalesRepId": 100000279
}
],
"total": 1
}List service categories
List the business's service categories (Mindbody calls them programs), such as Yoga classes or Massage appointments.
Inputs
- Kind
schedule_typetext - Only categories of this kind.One of:
All,Class(Classes),Enrollment(Enrollments),Appointment(Appointments),Resource(Resources),Media,Arrival(Arrivals). - Online only
online_onlytrue/false - Only categories shown online.
Outputs
countnumber- How many there are
programslist- The service categories
Example output
{
"count": 1,
"programs": [
{
"CancelOffset": 24,
"Id": 22,
"Name": "Massage",
"ScheduleType": "Appointment"
}
]
}List session types
List the kinds of class and appointment the business offers, with their usual length.
Inputs
- Service category
program_idtext - Only this service category (Mindbody calls them programs).
- Online only
online_onlytrue/false - Only types bookable online.
Outputs
countnumber- How many there are
session_typeslist- The session types
Example output
{
"count": 1,
"session_types": [
{
"Category": "Massage",
"CategoryId": 3,
"DefaultTimeLength": 60,
"Id": 5,
"Name": "60-minute massage",
"NumDeducted": 1,
"OnlineDescription": "",
"ProgramId": 22,
"Type": "Appointment"
}
]
}List staff
List the business's staff members. Gets one page.
Inputs
- Only staff who
filterslist - Narrow the list. Leave empty for everyone.One or more of:
StaffViewable(Shown to clients),AppointmentInstructor(Takes appointments),ClassInstructor(Teaches classes),Male,Female. - How many
limitnumber - How many to return, 1 to 200. Mindbody's default is 100.From 1 to 200.
- Skip
offsetnumber - How many to skip, to get the next page. Starts at 0.At least 0.
Outputs
countnumber- How many came back in this page
offsetnumber- How many were skipped
stafflist- The staff members
totalnumber- How many there are in all
Example output
{
"count": 1,
"offset": 0,
"staff": [
{
"AppointmentInstructor": true,
"Bio": "",
"ClassTeacher": true,
"DisplayName": "Ashley",
"Email": "ashley@example.com",
"FirstName": "Ashley",
"Id": 100000279,
"ImageUrl": "",
"IndependentContractor": false,
"LastName": "Knight",
"MobilePhone": "8055550101",
"Name": "Ashley Knight"
}
],
"total": 1
}Remove client from class
Cancel a client's booking in a class.
Inputs
- Client ID
client_idtextRequired - The client's ID in Mindbody, from 'List clients' or an earlier step.
- Class ID
class_idtextRequired - The class's ID, from 'List classes' or an earlier step.
- Late cancel
late_canceltrue/false - Record it as a late cancellation (the business's late-cancel rules apply).
- Send email
send_emailtrue/false - Send the client Mindbody's automatic email for this, if the business has it set up. Off unless you turn it on.
Outputs
classobject- The class the client left
removedtrue/false- True once removed
Example output
{
"class": {
"ClassDescription": {
"Category": "Yoga",
"Description": "An easy-going vinyasa class.",
"Id": 77,
"Name": "Morning Flow",
"Program": {
"CancelOffset": 12,
"Id": 21,
"Name": "Yoga",
"ScheduleType": "Class"
},
"SessionType": {
"Category": "Massage",
"CategoryId": 3,
"DefaultTimeLength": 60,
"Id": 6,
"Name": "Yoga",
"NumDeducted": 1,
"OnlineDescription": "",
"ProgramId": 22,
"Type": "Class"
}
},
"ClassNotes": "",
"ClassScheduleId": 410,
"EndDateTime": "2026-11-07T09:00:00",
"Id": 3300,
"IsAvailable": true,
"IsCanceled": false,
"IsWaitlistAvailable": false,
"LastModifiedDateTime": "2026-11-01T09:00:00",
"Location": {
"Address": "100 Main St",
"Address2": "",
"City": "San Luis Obispo",
"Description": "Our main studio",
"HasClasses": true,
"Id": 1,
"Name": "Downtown Studio",
"Phone": "8055550100",
"PostalCode": "93401",
"SiteId": -99,
"StateProvCode": "CA"
},
"MaxCapacity": 20,
"Staff": {
"AppointmentInstructor": true,
"Bio": "",
"ClassTeacher": true,
"DisplayName": "Ashley",
"Email": "ashley@example.com",
"FirstName": "Ashley",
"Id": 100000279,
"ImageUrl": "",
"IndependentContractor": false,
"LastName": "Knight",
"MobilePhone": "8055550101",
"Name": "Ashley Knight"
},
"StartDateTime": "2026-11-07T08:00:00",
"Substitute": false,
"TotalBooked": 8,
"TotalBookedWaitlist": 0,
"TotalSignedIn": 0,
"VirtualStreamLink": "",
"WebBooked": 5,
"WebCapacity": 15
},
"removed": true
}Update appointment
Move an appointment, change who it's with or its notes, or mark it confirmed, arrived or completed. Only the fields you fill in change.
Inputs
- Appointment ID
appointment_idtextRequired - The appointment's ID, from 'List appointments' or an earlier step.
- New start
start_date_timedate and time - A new start time.
- New end
end_date_timedate and time - A new end time.
- Staff member
staff_idtext - A different staff member.
- Session type
session_type_idtext - A different kind of appointment.
- Notes
notestext - New notes on the appointment.
- Mark as
status_actiontext - Change the appointment's status.One of:
confirm,unconfirm,arrive(Mark arrived),unarrive(Undo arrived),complete(Mark completed). - Send email
send_emailtrue/false - Send the client Mindbody's automatic email for this, if the business has it set up. Off unless you turn it on.
Outputs
appointmentobject- The appointment
Example output
{
"appointment": {
"ClientId": "100015678",
"Duration": 60,
"EndDateTime": "2026-11-10T15:00:00",
"FirstAppointment": true,
"GenderPreference": "None",
"Id": 51234,
"LocationId": 1,
"Notes": "",
"ProgramId": 22,
"SessionTypeId": 5,
"StaffId": 100000279,
"StaffRequested": false,
"StartDateTime": "2026-11-10T14:00:00",
"Status": "Booked"
}
}Update client
Change a client's details, or make them active or inactive. Only the fields you fill in change.
Inputs
- Client ID
client_idtextRequired - The client's ID in Mindbody, from 'List clients' or an earlier step.
- First name
first_nametext - The client's first name. Leave empty to keep it.
- Last name
last_nametext - The client's last name. Leave empty to keep it.
- Email
emailtext - The client's email address. Leave empty to keep it.
- Mobile phone
mobile_phonetext - The client's mobile number. Leave empty to keep it.
- Birthday
birth_datedate - The client's date of birth. Leave empty to keep it.
- Street address
address_line_1text - The first address line. Leave empty to keep it.
- City
citytext - The client's city. Leave empty to keep it.
- State or province
statetext - The client's state. Leave empty to keep it.
- Postal code
postal_codetext - The client's postal code. Leave empty to keep it.
- Staff notes
notestext - Notes for staff on the client's account; clients don't see them. Leave empty to keep it.
- Prospect
is_prospecttrue/false - Mark the client as a prospect (a lead who hasn't bought yet).
- Home location
home_location_idtext - The location the client mostly visits. Leave empty to keep it.
- Active or inactive
statustext - Make the client active or inactive. Leave empty to keep it as it is.One of:
active,inactive.
Outputs
clientobject- The client
Example output
{
"client": {
"AccountBalance": 0,
"Active": true,
"AddressLine1": "1 Elm St",
"BirthDate": "1990-04-01T00:00:00",
"City": "San Luis Obispo",
"Country": "US",
"CreationDate": "2026-11-05T10:12:00",
"Email": "jo@example.com",
"FirstName": "Jo",
"HomeLocation": {
"Address": "100 Main St",
"Address2": "",
"City": "San Luis Obispo",
"Description": "Our main studio",
"HasClasses": true,
"Id": 1,
"Name": "Downtown Studio",
"Phone": "8055550100",
"PostalCode": "93401",
"SiteId": -99,
"StateProvCode": "CA"
},
"HomePhone": "",
"Id": "100015678",
"IsProspect": false,
"LastModifiedDateTime": "2026-11-05T10:12:00",
"LastName": "Bloggs",
"MobilePhone": "8055550123",
"Notes": "",
"PostalCode": "93401",
"State": "CA",
"Status": "Non-Member",
"UniqueId": 100015678
}
}