Update appointment with the Acuity Scheduling API
Updates the client details, intake answers or notes of an appointment and returns it. Only the fields sent change, and firstName and lastName cannot be cleared. Date, time and calendar change with Reschedule appointment.
- Identifier
- acuity_update_appointment
The request
POST https://connect.reportei.com/api/tools/acuity_update_appointment/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"id": 1
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | Yes | Id of the appointment: the id from List appointments or Create appointment. |
| firstName | string | No | First name of the client. |
| lastName | string | No | Last name of the client. |
| string | No | Email address of the client. It can only be cleared when admin is true. | |
| phone | string | No | Phone number of the client. |
| certificate | string | No | Package or coupon code to apply to the appointment. Only with admin true. |
| notes | string | No | Notes on the appointment. Only with admin true. |
| fields | array | No | New answers to intake form fields of the appointment. |
| smsOptIn | boolean | No | true when the client agreed to receive SMS, for appointment types that ask for this consent. false stops the SMS reminder. |
| admin | boolean | No | true to update as the business: notes and certificate allowed, without the client validations. |
Supported connections
Your customer connects their Acuity Scheduling account once, with one of the modes below. The same connection serves every tool of the toolkit.
Username and password
Your customer enters the app credentials on a Connect screen, or your system sends them with POST /api/customer-toolkits, with no screen.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/acuity_update_appointment. It becomes your agent's tool definition with no conversion.
Other Acuity Scheduling tools
- List appointmentsGETLists the scheduled appointments of the account, newest first by default, up to max per call. There is no page token: when a call returns max appointments, narrow minDate and maxDate. Canceled appointments only come with canceled or showall.
- Get appointmentGETReturns one appointment, with the client's name, email and phone, datetime, endTime, type, calendar, price, paid, notes, the intake answers in forms, labels and confirmationPage. A canceled appointment also has noShow.
- Create appointmentPOSTBooks an appointment and returns it. By default it is booked as a client would book it: the time must be open and the required intake fields answered. With admin true those checks are skipped and calendarID is required. The client gets the confirmation email and SMS unless noEmail is true.
- Cancel appointmentPUTCancels an appointment and returns it. A canceled appointment cannot be restored. By default the cancellation rules for clients apply; with admin true they are skipped and noShow can be set. The client gets the cancellation email and SMS unless noEmail is true.
- Reschedule appointmentPUTMoves an appointment to another date and time, another calendar or both, and returns it. The new time must be open unless admin is true. Canceled appointments and class series cannot be rescheduled. The client gets the rescheduling email and SMS unless noEmail is true.
- List appointment typesGETLists the appointment types, the services and classes that clients book, with id, name, duration in minutes, price, type (service, class or series), private and calendarIDs, the calendars that offer each one.
- List calendarsGETLists the calendars the account can access, usually one per staff member, with id, name, email, location and timezone.
- List available datesGETLists the dates of a month that have open times for an appointment type, the same dates the client scheduling page shows. Each item has date.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
