Change an appointment
/api/v1/appointments/{id}A new time (or, for a table, a new party size) goes through the same change function as the guest's own change on their manage link: the venue's allocator, layouts, locks, hours and every other booking, leaving this booking out of its own way, then the deposit for the new time and party size; the booking window binds a new time. A change never takes money: one that would owe a deposit or a card the booking does not hold (a new time's service-period deposit, or a bigger party crossing the venue's deposit or card rule) is a 409 payment_required. A party size change on a booking that already holds a deposit or a card is refused outright, for the venue to settle. The guest is told about a new time with the venue's usual change notice. Only a confirmed or pending booking that has not started can change. Send only the fields you are changing. The service and team member stay as booked.
Authorization
bearerApiKey appointments:writeBuild with a test key (sk_test_...): it works only in your API sandbox and never emails or texts anyone. Scopes, errors and limits.
In: header
Scope: appointments:write
Path Parameters
Appointment id.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
1 <= propertiesResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/api/v1/appointments/string" \ -H "Content-Type: application/json" \ -d '{}'{ "data": {}}List staffGET
The appointments engine's staff members. Engine-guarded, ordered by `id`: see `GET /api/v1/services` for why. **`serviceIds` lists the services each staff member performs**, the fact a program needs before it can offer anyone a slot. It is filtered to the key's own organization like every other field.
Cancel an appointmentPOST
Cancels on the guest's behalf, recorded as cancelled by the guest. The row is kept, the guest gets the venue's usual cancellation notice, and a paid deposit is settled by the venue's own refund window: `depositOutcome` says whether it was `refunded`, `forfeited`, `none`, or `failed` (the booking IS cancelled; the money needs a person). Only a `confirmed` or `pending` booking can be cancelled.