Acuity Scheduling

OAuth scopes: api-v1

Block off a specific time range on a calendar.

add_blocked_time · Risk: low · Retry: safe

Inputs

• start · string · Required, The start date and time for the block (ISO 8601 format).
• end · string · Required, The end date and time for the block (ISO 8601 format).
• calendarID · string · Required, The numeric ID of the calendar to add this block to.
• notes · string · Optional, Optional notes for the blocked off time.

Creates a new appointment.

create_appointment · Risk: low · Retry: safe

Inputs

• datetime · string · Required, Date and time of the appointment.
• appointmentTypeID · string · Required, Select the type of appointment.
• firstName · string · Required, Client's first name.
• lastName · string · Required, Client's last name.
• email · string · Optional, Client's email address. (Optional if booking as admin).
• phone · string · Optional, Client's phone number.
• timezone · string · Required, Client's timezone (e.g., America/New_York). Required for accurate availability checking.
• adminBooking · boolean · Optional, Set to true to book as an admin. Disables availability/attribute validations, allows setting notes, and makes Calendar ID required.
• calendarID · string · Optional, Numeric ID of the calendar. Required if booking as admin. If not provided, Acuity tries to find an available calendar automatically for non-admin bookings.
• noEmail · boolean · Optional, If true, confirmation emails or SMS will not be sent.
• certificate · string · Optional, Package or coupon certificate code.
• notes · string · Optional, Appointment notes. Only settable if booking as admin.
• smsOptIn · boolean · Optional, Indicates whether the client has explicitly given permission to receive SMS messages.
• addonIDs · array · Optional, Select addons for the appointment. Addons are filtered by selected Appointment Type if available.
• labelId · string · Optional, Apply a label to the appointment. The API currently supports one label.

Creates a new client.

create_client · Risk: low · Retry: safe

Inputs

• firstName · string · Required, Client's first name.
• lastName · string · Required, Client's last name.
• phone · string · Optional, Client's phone number.
• email · string · Optional, Client's email address.
• notes · string · Optional, Notes about the client.

Reschedules an existing appointment to a new date/time.

reschedule_appointment · Risk: low · Retry: safe

Inputs

• id · number · Required, The ID of the appointment to reschedule.
• appointmentTypeID · string · Required, Select the type of appointment (used for finding new available slots).
• datetime · string · Required, New Date and time of the appointment.
• timezone · string · Required, Client's timezone (e.g., America/New_York).
• calendarID · string · Optional, Numeric ID of the new calendar to reschedule to. If blank, stays on current calendar. Submit 0 to auto-assign.
• adminReschedule · boolean · Optional, Set to true to reschedule as an admin. Disables availability validations.
• noEmail · boolean · Optional, If true, rescheduling emails or SMS will not be sent.

Updates an existing client.

update_client · Risk: low · Retry: safe

Inputs

• currentFirstName · string · Required, The current first name of the client to update.
• currentLastName · string · Required, The current last name of the client to update.
• currentPhone · string · Optional, The current phone number of the client to update. Helps identify the client if names are not unique.
• newFirstName · string · Optional, Client's new first name. Leave blank to keep current.
• newLastName · string · Optional, Client's new last name. Leave blank to keep current.
• newEmail · string · Optional, Client's new email address. Leave blank to keep current.
• newPhone · string · Optional, Client's new phone number. Leave blank to keep current.
• newNotes · string · Optional, New notes about the client. Leave blank to keep current.

Find appointments based on various criteria, including client information.

find_appointment · Risk: low · Retry: safe

Inputs

• firstName · string · Optional, Filter appointments by client first name.
• lastName · string · Optional, Filter appointments by client last name.
• email · string · Optional, Filter appointments by client e-mail address.
• phone · string · Optional, Filter appointments by client phone number. URL encode '+' if using country codes (e.g., 1234567890).
• minDate · string · Optional, Only get appointments on or after this date.
• maxDate · string · Optional, Only get appointments on or before this date.
• calendarID · string · Optional, Show only appointments on the calendar with this ID.
• appointmentTypeID · string · Optional, Show only appointments of this type.
• status · string · Optional, Filter by appointment status.
• maxResults · number · Optional, Maximum number of results to return (default 100).
• direction · string · Optional, Sort direction for the results.

Finds client based on seach term.

find_client · Risk: low · Retry: safe

Inputs

• search · string · Required, Filter client list by first name, last name, or phone number.

Make a custom API call to a specific endpoint

custom_api_call · Risk: low · Retry: safe

Inputs

• url · object · Required
• method · string · Required
• headers · object · Optional, Authorization headers are injected automatically from your connection.
• queryParams · object · Optional, Appended to the URL as ?key=value.
• body_type · string · Optional
• body · object · Optional
• response_is_binary · boolean · Optional, Enable for files like PDFs, images, etc.
• failsafe · boolean · Optional, On a failed request, output the error instead of failing the step.
• timeout · number · Optional, Seconds to wait for a response. Empty: up to the flow limit (10 min).
• followRedirects · boolean · Optional, Follow 3xx redirects instead of returning them as the response.

Triggers when an appointment is canceled.

Inputs

• calendarId · string
• appointmentTypeId · string

Triggers when a new appointment is scheduled.

Inputs

• calendarId · string
• appointmentTypeId · string