createHeldReservation( )


Developer Preview

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

Creates a new temporary reservation and holds it for the customer for 10 minutes.

Creates a new reservation with the HELD status. HELD reservations 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 change a HELD reservation’s status after 10 minutes returns an error.

You cannot call updateReservation() to change a reservation’s status from HELD. Trying to do so returns an error. Instead, you should use reserveReservation().

If you do not wish to have HELD reservations in your flow, you can create a reservation with all required details using createReservation().

Permissions
Manage Reservations (Medium)
Manage Reservations (Full)
Manage Restaurants - all permissions
Manage Reservations (Basic)
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
reservationDetailsHeldReservationDetailsRequired

Held reservation information to update.

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