Cancel Appointment
acuity_scheduling.cancel_appointment
ActionBusiness appsconnection required
Calls the Acuity Scheduling API with the connection's credentials.
Cancel an appointment, optionally recording it as a client no-show.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Username & password
- Providers
- Acuity Scheduling
- Secret shape
- {"user_id": "123456", "api_key": "…"}
- Config it needs
- calendar_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
5 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
appointment_id Numeric id of the appointment to act on, as returned by acuity_scheduling.list_appointments. | string | Yes | — | — | 123456789 |
cancel_note A message included in the cancellation notification sent to the client. | string | No | — | — | — |
no_show Record the cancellation as a no-show; Acuity only accepts this when 'admin' is on. | boolean | No | false | — | — |
admin Act as an administrator: availability rules are not enforced and admin-only fields such as notes become writable. | boolean | No | false | — | — |
no_email Suppress the confirmation email and SMS Acuity would otherwise send the client. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"admin": false,
"appointment_id": "123456789",
"no_email": false,
"no_show": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id Numeric id of the appointment. | number | — |
firstName The client's first name. | string | — |
lastName The client's last name. | string | — |
email The client's email address. | string | — |
phone The client's phone number, empty when none was given. | string | — |
datetime Start of the appointment as an ISO-8601 timestamp. | string | — |
endTime End of the appointment, in the business's local format. | string | — |
duration Length of the appointment in minutes. | string | — |
type Name of the appointment type that was booked. | string | — |
appointmentTypeID Numeric id of the appointment type. | number | — |
calendar Name of the calendar the appointment sits on. | string | — |
calendarID Numeric id of that calendar. | number | — |
price Price of the appointment in the account's currency. | string | — |
paid Whether the appointment has been paid for. | string | — |
canceled True once the appointment has been canceled. | boolean | — |
notes Internal notes on the appointment. | string | — |
forms Intake form answers, one entry per form. | array | — |
confirmationPage URL of the client-facing confirmation page. | string | — |
{
"appointmentTypeID": 0,
"calendar": "",
"calendarID": 0,
"canceled": false,
"confirmationPage": "",
"datetime": "",
"duration": "",
"email": "",
"endTime": "",
"firstName": "",
"forms": [],
"id": 0,
"lastName": "",
"notes": "",
"paid": "",
"phone": "",
"price": "",
"type": ""
}See Cancel Appointment run in a workflow.
In a technical demo we add the Acuity Scheduling connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.