updateReservation( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates a reservation.

Including the fields status, source, reservation.details.tableIds, reservation.details.endDate, ignoreReservationLocationConflicts, and ignoreTableCombinationConflicts in the request requires additional permissions. See this API's Introduction article for more information.

Each time the reservation is updated, revision increments by 1. The existing revision must be included when updating the reservation. This ensures you're working with the latest reservation information, and it prevents unintended overwrites.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Reservations (Medium)
Manage Reservations (Full)
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
_idstringRequired

Reservation ID.

reservationUpdateReservationRequired

Reservation information to update.

optionsUpdateReservationOptions

Options for updating the reservation.

Returns
Return Type:Promise<Reservation>
Was this helpful?
Yes
No