Bookings
Appointments your customers booked, and the kinds of appointment on offer. Read them, enter one on a customer's behalf, book a follow-up for a customer who already has one, and move, cancel or close one out — cancelling refunds and mails the customer the same way the planner does. Availability and schedules stay in the planner.
List bookings
Filterable, sortable, paginated list of appointments. Requires the `read:bookings` scope.
Create a booking
Book an appointment on a customer's behalf. It is confirmed immediately and counts as entered by hand (`source: PLANNER`), so no payment is taken — a paid type stays `UNPAID` until you settle it and mark it paid. The customer receives the normal confirmation mail. `startsAt` must be a slot the availability engine offers; anything else answers 409 `slot_unavailable`. Requires the `write:bookings` scope.
Get a booking
Fetch a single appointment. Requires the `read:bookings` scope.
List appointment types
The kinds of appointment your customers can book. Use a type's `slug` when creating a booking. Requires the `read:bookings` scope.
Book a follow-up
Book the next appointment for the customer of an existing booking. Name, contact details and the offer-request link are taken from that booking, so the body only says when — and, where it should differ, which appointment type and which team member. A follow-up is confirmed immediately, counts as entered by hand (`source: PLANNER`), is free of charge whatever its type costs, and points back at the booking it follows through `followUpOf`. The customer receives the normal confirmation mail. Only a booking that is CONFIRMED, COMPLETED or NO_SHOW can be followed up; any other answers 409 `follow_up_not_allowed`. `startsAt` must be a slot the availability engine offers, otherwise the call answers 409 `slot_unavailable`. Requires the `write:bookings` scope.
Cancel a booking
Cancel an appointment, release its slot and mail the customer. Set `refund` to send a paid customer their money back. Requires the `write:bookings` scope.
Reschedule a booking
Move a confirmed future appointment to another slot, re-push it to the connected calendar and send a new confirmation. Requires the `write:bookings` scope.
Mark a booking completed
Record that the appointment took place. Requires the `write:bookings` scope.
Mark a booking as a no-show
Record that the customer did not turn up. Requires the `write:bookings` scope.
Mark a booking paid
Record that a booking settled outside Stripe (cash, invoice, transfer) has been paid. Requires the `write:bookings` scope.