Cancels an appointment as a command: the response is the appointment with status: "cancelled" and cancelled_at set. Optionally stores a reason and whether to notify the client.
Requires Idempotency-Key. Cancelling an already cancelled appointment with the same key is a no-op returning the same result.
A cancelled appointment stays readable: getAppointment returns it with status: "cancelled" rather than 404, and listAppointments keeps returning it, so a client synchronising the journal sees the cancellation instead of silently losing the row. Filter on the status field to hide them. In a visit built from several appointments, cancelling one does not cancel the visit: the remaining appointments and any payments already recorded stay, and amount_to_pay_minor is recomputed when the visit is read.
Client-generated unique key for this logical request (UUID recommended). A retry with the same key and body returns the original result; the same key with a different body fails with 409 idempotency_key_reused. Keys are retained at least 24 hours and are scoped to credential, Location, and operation; after expiry the value may be reused for a new logical request.
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v3/openapi/locations/{location_id}/appointments/{appointment_id}/cancel
- Preview resource API contract - endpoint surface is not live yethttps://api.alteg.io/api/v3/locations/{location_id}/appointments/{appointment_id}/cancel
- OAuth2
- RestrictedKey
curl -i -X POST \
'https://developer.alteg.io/_mock/en/b2b-v3/openapi/locations/{location_id}/appointments/{appointment_id}/cancel' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: string' \
-d '{
"reason": "client_request",
"notify_client": true
}'The cancelled appointment.
Requests left in the most constrained policy window that applies to this request.
On 429, seconds until the most constrained policy frees up; it equals Retry-After there. On a successful response it reports the length of that policy's window rather than the time left in the current one, so treat it as the window size, not as a countdown — the counter to pace against is RateLimit-Remaining.
Most constrained policy applied to the request, as <limit>;w=<window in seconds>.
Status of an appointment. waiting — scheduled, not yet confirmed; confirmed — confirmed by the client; arrived — the client attended (terminal "done" state); no_show — the client did not attend; cancelled — cancelled via the cancel command (never set through the status command).
{ "id": 12345, "object": "appointment", "location_id": 4321, "client_id": 789, "visit_id": 5001, "team_member_id": 321, "service_ids": [ 100 ], "resource_instance_ids": [], "status": "cancelled", "starts_at": "2026-07-24T11:30:00+01:00", "ends_at": "2026-07-24T12:30:00+01:00", "duration_seconds": 3600, "is_paid": false, "comment": null, "cancelled_at": "2026-07-22T05:15:00Z", "cancellation_reason": "client_request", "created_at": "2026-07-20T09:57:15Z", "updated_at": "2026-07-22T05:15:00Z" }