amend_booking
Change a booking. Change a booking’s date, time, party size or notes, keeping its reference. Give only what changes. outcome unavailable means the new time is full: offer the alternatives. needs_venue means the venue’s team has been asked and will be in touch: tell the guest. If a deposit top-up is due, offer to text a payment link with send_deposit_link.
It changes data. 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. |
date |
string | No | New venue-local date as yyyy-MM-dd. |
time |
string | No | New venue-local time as HH:mm. |
partySize |
integer | No | New number of guests. |
notes |
string | No | New notes for the venue. |
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”AmendBooking: POST /public/v1/bookings/{reference}/amend, which needs the bookings.manage capability.