cancel_booking
Cancel a booking. Cancel a booking. Confirm with the guest first: it frees the table at once. A paid deposit is never refunded here; the venue’s team will be in touch about it, and the summary says so. needs_venue means it’s too close to the booking to cancel online and the venue has been asked.
It changes data and can undo a booking, so confirm with the guest first. Calling it again with the same input has no further effect.
Parameters
Section titled “Parameters”| Name | Type | Required | Description |
|---|---|---|---|
reference |
string | Yes | The booking reference, eight digits; spaces are fine. |
phone |
string | Yes | The phone number on the booking. |
reason |
string | No | Why the guest is cancelling, if they said. |
venueId |
string (uuid) | No | The venue’s id, when the key covers several venues. |
idempotencyKey |
string | No | Optional: your own key for this request, to make retries safe beyond 10 minutes. |
REST equivalent
Section titled “REST equivalent”CancelBooking: POST /public/v1/bookings/{reference}/cancel, which needs the bookings.manage capability.