Developer Documentation

Modify Reservation

This API call allows an external system to modify an existing reservation within Passkey. It cannot be used to create a new reservation.

These messages are based on the OpenTravel (OTA) standards. This is a full overlay modification, any elements of the reservation that are not included in the Modify call will be removed.

ModifyReservationRQ

<?xml version="1.0" encoding="UTF-8"?>
<ModifyReservationRQ xmlns="http://www.Cvent Passkey.com/apiSchema" xmlns:ota="http://www.opentravel.org/OTA/2002/11" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <Security>
      <Login>
         <UserName>reglinkapi</UserName>
         <Password>passkey1</Password>
      </Login>
      <PartnerID>136260</PartnerID>
      <Token> </Token>
   </Security>
   <Message>
      <Version>4.00.04</Version>
      <Mode>S</Mode>
      <OP>ModifyReservation</OP>
      <Service>ModifyReservation</Service>
      <Locale>EN_US</Locale>
   </Message>
   <Data>
      <ota:OTA_HotelResRQ>
         <ota:HotelReservations>
            <ota:HotelReservation CreateDateTime="2018-06-10T16:19:59.363-05:00" LastModifyDateTime="2020-06-10T17:19:59.363-05:00" RoomStayReservation="1">
               <ota:UniqueId Type="RES" Id="328T7923"/>
               <ota:RoomStays>
                  <ota:RoomStay>
                     <ota:RoomTypes>
                        <ota:RoomType NumberOfUnits="1"/>
                     </ota:RoomTypes>
                     <ota:GuestCounts>
                        <ota:GuestCount AgeQualifyingCode="1" Count="2"/>
                     </ota:GuestCounts>
                  </ota:RoomStay>
               </ota:RoomStays>
               <ota:ResGuests>
                  <ota:ResGuest ResGuestRPH="1">
                     <ota:Profiles>
                        <ota:ProfileInfo>
                           <ota:Profile>
                              <ota:Customer>
                                 <ota:PersonName>
                                    <ota:NamePrefix>Mr.</ota:NamePrefix>
                                    <ota:GivenName>Jöhèn</ota:GivenName>
                                    <ota:MiddleName>Test</ota:MiddleName>
                                    <ota:Surname>Pãsskéy</ota:Surname>
                                 </ota:PersonName>
                                 <ota:Telephone PhoneNumber="6173281461" PhoneTechType="3"/>
                                 <ota:Telephone PhoneNumber="6173284800" PhoneTechType="1"/>
                                 <ota:Email>noreply@Cvent.com</ota:Email>
                                 <ota:Address>
                                    <ota:AddressLine>221 Crescent Street</ota:AddressLine>
                                    <ota:AddressLine>Suite 201</ota:AddressLine>
                                    <ota:CityName>Boston</ota:CityName>
                                    <ota:PostalCode>02170</ota:PostalCode>
                                    <ota:StateProv>MA</ota:StateProv>
                                    <ota:CountryName Code="US">United States</ota:CountryName>
                                 </ota:Address>
                                 <ota:EmployeeInfo>Software Eng</ota:EmployeeInfo>
                              </ota:Customer>
                              <ota:PrefCollections>
                                 <ota:PrefCollection>
                                    <ota:HotelPref SmokingAllowed="0">
                                       <ota:PhysChallFeaturePref PhysChallFeature="0">0</ota:PhysChallFeaturePref>
                                       <ota:SpecRequestPref>Extra towels and high floor</ota:SpecRequestPref>
                                    </ota:HotelPref>
                                 </ota:PrefCollection>
                              </ota:PrefCollections>
                              <ota:CompanyInfo>
                                 <ota:CompanyName>Cvent</ota:CompanyName>
                              </ota:CompanyInfo>
                           </ota:Profile>
                        </ota:ProfileInfo>
                     </ota:Profiles>
                  </ota:ResGuest>
                  <ota:ResGuest ResGuestRPH="2">
                     <ota:Profiles>
                        <ota:ProfileInfo>
                           <ota:Profile>
                              <ota:Customer>
                                 <ota:PersonName>
                                    <ota:NamePrefix>Ms.</ota:NamePrefix>
                                    <ota:GivenName>Joanna</ota:GivenName>
                                    <ota:MiddleName>p</ota:MiddleName>
                                    <ota:Surname>Smith</ota:Surname>
                                 </ota:PersonName>
                                 <ota:Telephone PhoneNumber="6173281461" PhoneTechType="3"/>
                                 <ota:Telephone PhoneNumber="6173284800" PhoneTechType="1"/>
                                 <ota:Email>noreply2@cvent.com</ota:Email>
                                 <ota:Address>
                                    <ota:AddressLine>221 Crescent Street</ota:AddressLine>
                                    <ota:AddressLine>Suite 201</ota:AddressLine>
                                    <ota:CityName>Boston</ota:CityName>
                                    <ota:PostalCode>02170</ota:PostalCode>
                                    <ota:StateProv>MA</ota:StateProv>
                                    <ota:CountryName Code="US">United States</ota:CountryName>
                                 </ota:Address>
                                 <ota:EmployeeInfo>Software Eng</ota:EmployeeInfo>
                              </ota:Customer>
                              <ota:PrefCollections>
                                 <ota:PrefCollection>
                                    <ota:HotelPref SmokingAllowed="0">
                                       <ota:PhysChallFeaturePref PhysChallFeature="0">0</ota:PhysChallFeaturePref>
                                       <ota:SpecRequestPref>high floor and early check in</ota:SpecRequestPref>
                                    </ota:HotelPref>
                                 </ota:PrefCollection>
                              </ota:PrefCollections>
                              <ota:CompanyInfo>
                                 <ota:CompanyName>Cvent</ota:CompanyName>
                              </ota:CompanyInfo>
                           </ota:Profile>
                        </ota:ProfileInfo>
                     </ota:Profiles>
                  </ota:ResGuest>
               </ota:ResGuests>
               <ota:ResGlobalInfo>
                  <ota:GuestCounts>
                     <ota:GuestCount AgeQualifyingCode="1" Count="2"/>
                  </ota:GuestCounts>
                  <ota:TimeSpan>
                     <ota:StartDateWindow EarliestDate="2022-12-21" LatestDate="2022-12-27"/>
                  </ota:TimeSpan>
                  <ota:ResGuestRPHs>
                     <ota:ResGuestRPH/>
                  </ota:ResGuestRPHs>
                  <ota:Memberships/>
                  <ota:Guarantee>
                     <ota:GuaranteesAccepted>
                        <ota:GuaranteeAccepted>
                           <ota:PaymentCard CardNumber="1245454787854124" ExpireDate="0625" CardType="100">
                              <ota:CardHolderName>Joanna Smith</ota:CardHolderName>
                              <ota:Address>
                                 <ota:AddressLine>221 Crescent Street</ota:AddressLine>
                                 <ota:AddressLine>Suite 201</ota:AddressLine>
                                 <ota:CityName>Boston</ota:CityName>
                                 <ota:PostalCode>02062</ota:PostalCode>
                                 <ota:StateProv>MA</ota:StateProv>
                                 <ota:CountryName Code="US">United States</ota:CountryName>
                              </ota:Address>
                           </ota:PaymentCard>
                        </ota:GuaranteeAccepted>
                     </ota:GuaranteesAccepted>
                  </ota:Guarantee>
                  <ota:HotelReservationIDs>
                     <ota:HotelReservationID/>
                  </ota:HotelReservationIDs>
               </ota:ResGlobalInfo>
               <ota:TPA_Extensions>
                  <ota:PK_Info>
                     <ota:EventID>151592</ota:EventID>
                     <ota:AttendeeCode>RTEATT0117FBV</ota:AttendeeCode>
                     <ota:SendAck>true</ota:SendAck>
                     <ota:ExtReferenceID>ABC-123</ota:ExtReferenceID>
                     <ota:HowBooked>100</ota:HowBooked>
                     <ota:ReceivedFrom>2200</ota:ReceivedFrom>
                     <ota:PaymentType>other</ota:PaymentType>
                     <ota:BlockID>104636889</ota:BlockID>
                     <ota:OtherPayment>
                        <ota:OPayAmt Amount="600"/>
                        <ota:OPayDate>2004-11-04</ota:OPayDate>
                        <ota:OPayReferenceNum>Reference Text</ota:OPayReferenceNum>
                        <ota:OPayCheckNum>1234</ota:OPayCheckNum>
                        <ota:OPayReceived>true</ota:OPayReceived>
                        <ota:OPayComments>Guest to provide a credit card at check in.</ota:OPayComments>
                        <ota:OPayName>Alexander Thomson</ota:OPayName>
                        <ota:OBillAddress>
                           <ota:AddressLine>221 Crescent Street</ota:AddressLine>
                           <ota:AddressLine>Suite 201</ota:AddressLine>
                           <ota:CityName>Boston</ota:CityName>
                           <ota:PostalCode>02062</ota:PostalCode>
                           <ota:StateProv>MA</ota:StateProv>
                           <ota:CountryName Code="US">United States</ota:CountryName>
                        </ota:OBillAddress>
                        <ota:OPhone PhoneNumber="16173284800"/>
                     </ota:OtherPayment>
                     <ota:BillPhone PhoneNumber="16173284800"/>
                     <ota:PrimaryGuestRPH>1</ota:PrimaryGuestRPH>
                     <ota:CustomFields>
                        <ota:CustomField1>This is a 4.00.04 test of CustomField1.</ota:CustomField1>
                        <ota:CustomField2>This is a 4.00.04 test of CustomField2.</ota:CustomField2>
                        <ota:CustomField3>This is a 4.00.04 test of CustomField3.</ota:CustomField3>
                        <ota:CustomField4>This is a 4.00.04 test of CustomField4.</ota:CustomField4>
                        <ota:CustomField5>This is a 4.00.04 test of CustomField5.</ota:CustomField5>
                     </ota:CustomFields>
                     <ota:Referrer>http://www.Cvent.com</ota:Referrer>
                  </ota:PK_Info>
               </ota:TPA_Extensions>
            </ota:HotelReservation>
         </ota:HotelReservations>
      </ota:OTA_HotelResRQ>
   </Data>
</ModifyReservationRQ>

ModifyReservationRS

<?xml version="1.0" encoding="ISO-8859-1"?>
<PasskeyRS xmlns="http://www.passkey.com/apiSchema" xmlns:ns1="http://www.passkey.com/apiSchema" xmlns:ota="http://www.opentravel.org/OTA/2002/11" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <Message GUID="1638e6bf162:-568720">
      <Status ID="2">PROCESSED</Status>
   </Message>
   <Data>
      <ota:OTA_HotelResRS>
         <ota:Success/>
         <ota:HotelReservations>
            <ota:HotelReservation RoomStayReservation="1">
               <ota:UniqueId Id="328T7923" Type="RES"/>
            </ota:HotelReservation>
         </ota:HotelReservations>
      </ota:OTA_HotelResRS>
   </Data>
</PasskeyRS>

Last updated on January 8, 2025

Create Reservation Cancel Reservation