reserveReservation( )

Developer Preview

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

Reserves or requests a held reservation.

Held reservations are temporary reservations with the HELD status created by createHeldReservation().

They are intended to reserve seats and tables for a party in a selected time slot while they enter further reservation details, such as names and contact information. Reservations with the HELD status are only valid for 10 minutes. Trying to call Reserve Reservation with a held reservation older than 10 minutes returns an error.

Reserve Reservation changes a reservation's HELD status to:

  • RESERVED if the reservation's reservation location does not require manual approval.
  • REQUESTED if the reservation's reservation location requires manual approval.

Permission Scopes

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

Reservation ID.

reserveeReserveeRequired

Reservee details.

revisionstringRequired

Revision number.

Include the existing revision to prevent conflicting updates to reservations.

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