ReservationRequest API calls allow a third-party application to create, modify, get, or cancel a ReservationRequest (formerly known as a Bridge Record). This record contains registrant information (name, address, email, etc.) and optional stay information such as staydates and roomtype.

As part of the API response, Passkey returns a unique ID and a guest-specific URL to our booking site. The guest can then use this link to create a reservation in the Passkey booking site – their information will be pre-populated there. The created reservation will remain associated with the ReservationRequest ID.

If desired, you can also use our callback functionality to pass reservation information from Passkey back to your system when the reservation is created, modified, or cancelled in our system (commonly followed by a GetReservation call).

Create ReservationRequest

The Create ReservationRequest call allows an external system to create a record within Passkey to store an attendee’s information. Cvent Passkey will respond with an attendee-specific ID. It is important to note that while attendee information associated and stored with a ReservationRequest is similar to data stored with a housing reservation, it is not an actual reservation. Once a Bridge Record is saved it can be retrieved using the ID and used to create a housing reservation. For a sample of this request, see here.

Get ReservationRequest

The Get ReservationRequest call allows an external system to retrieve details for a particular ReservationRequest/Bridge Record. For a sample of this request, see here.

Update ReservationRequest

This message allows the external system to modify an existing ReservationRequest using the ID. It requires that a ReservationRequest ID be supplied. For a sample of this request, see here.

Cancel ReservationRequest

This message allows the external system to cancel an existing ReservationRequest using the ID. It requires that a ReservationRequest ID be supplied. For a sample of this request, see here.

These messages are based on the OpenTravel (OTA) standards and the order in which these messages are used must be followed. For example, you cannot use the Create ReservationRequest call to modify an existing ReservationRequest.

Last updated on