WS ParameterRequiredDescriptionAdditional CommentsSample DataXpath for XML Message
UserNameYUsername assigned by Cvent Passkey that has been granted API access.reglinkapi/CreateReservationRQ/Security/Login/UserName
PasswordYPassword associated with API Username.passkey1/CreateReservationRQ/Security/Login/Password
PartnerIDYUnique ID which represents the Partner Profile or “Organization” in Cvent Passkey.Assigned to all new partners at the time of setup in production.136260/CreateReservationRQ/Security/PartnerID
VersionYIdentifies the Event Connector API Message version used.Each Event Connector API Message will contain a version. Please note the most current supported version may differ between message types.4.00.02/CreateReservationRQ/Message/Version
ModeYCommunication Mode. Synchronous is the only mode supported for this API call.Synchronous=SS/CreateReservationRQ/Message/Mode
OPYAPI Operation/Message TypeCreateReservation/CreateReservationRQ/Message/OP
ServiceYAPI Service NameCreateReservation/CreateReservationRQ/Message/Service
LocaleYLocale for GuestPlease see the standard listing of locales or contact integrations@Cvent.com for a listing.EN_US/CreateReservationRQ/Message/Locale
HotelReservation/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations /HotelReservation[@RoomStayReservation=“true”]
RoomType/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations /RoomStays/RoomStay/RoomTypes/RoomType[@NumberOfUnits=“1”]
GuestCount/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations /RoomStays/RoomStay/GuestCounts/GuestCount[@AgeQualifyingCode=“1” Count=“2”]
ResGuest/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations /ResGuests/ResGuest[@ResGuestRPH=“1”]
NamePrefixNAttendee’s title1. Bishop 2. Brother 3. Dr. 4. Father 5. Frau 6. Herr 7. M. 8. Miss 9. Mlle. 10. Mme. 11. Mr. 12. Mrs. 13. Ms. 14. Prof. 15. Rabbi 16. Rep. 17. Rev. 18. Sister 19. Sr. 20. Sra. 21. Srta.Mr./CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/PersonName/NamePrefix
LastNameYAttendee’s Last NameSmith/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/PersonName/Surname
MiddleInitialNAttendee’s Middle Name / InitialP/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/PersonName/MiddleName
FirstNameYAttendee’s First NameSimon/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/PersonName/GivenName
AddressLineYAttendee’s Address Line 1221 Crescent Street/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Address/AddressLine
AddressLineNAttendee’s Address Line 2Building 17/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Address/AddressLine
CityYAttendee’s CityWaltham/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Address/CityName
StateProvYAttendee’s 2-letter State/Province code2-letter codeMA/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Address/StateProv
PostalCodeYAttendee’s Zip/Postal Code02453-123/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Address/PostalCode
CountryNameYISO 3166 2-letter codeUS/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Address/CountryName@Code
TelephoneYAttendee’s Phone NumberType “1” = BusinessTelephoneY
Type “3” = Fax781-373-4100/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Telephone[@PhoneTechType=“1”]/@ PhoneNumberType “3” = Fax781-373-4100/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Telephone[@PhoneTechType=“1”]/@ PhoneNumber
EmailYEmail Addressnoreply@Cvent.com/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo
EmployeeInfoNAttendee’s professional title/positionSoftware Engineer/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/EmployeeInfo
CompanyNameNAttendee’s Company or OrganizationCvent Solutions Inc./CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/CompanyInfo/CompanyName
EarliestDateYArrival date in format YYYY-MM-DD2018-12-01/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo/TimeSpan/StartDateWindow@EarliestDate
LatestDateYDeparture date in format YYYY-MM-DD2018-12-15/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo/TimeSpan/StartDateWindow@LatestDate
ExtReferenceIDYExternal Registration company record identifier (e.g., registration confirmation number)This number should be unique per hotel room reservation.ABC-123/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/ExtReferenceID
EventIDYThis is a unique code for a specific event, for example the “6th Annual Widget Maker’s Convention” would have a single event ID. This can be found in Cvent Passkey under the Event Home -> Website -> Event Website -> View All URLs and exposed at the end of the website URL ”…EventID=#######146021/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/EventID
AttendeeCodeYThis is a unique id which represents each Attendee Type within an Event. This can be used for General Attendees, VIP, Staff, etc. and can be found in Cvent Passkey under the Event Home -> Advanced Options -> Attendee Types. These codes are labeled as “Access Code” in the UI for each configured Attendee Type and typically formatted similar to “TMBATT041414”RTEATT0117/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/AttendeeCode
BlockIDYThis is a unique id which represents a specific Room Type and Attendee Type combination within an Event. This can be found in Cvent Passkey under the Event Home -> Advanced Options -> Blocks.104585385/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/BlockID
HotelID
HowBookedYHow the reservation was booked; numeric value between 100 and 105.100 = Phone 101 = Internet 102 = Email Form 103 = Fax Form 104 = Mail Form 105 = Other101/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/HowBooked
ReceivedFromYA free-text field to note the person or system creating the reservationA Reg Company, Inc./CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/ReceivedFrom
ResSplitFolioTypeIdYIndicates whether a multi-guest reservation should be created as a “Share-With” or “Accompanied-By” reservation.101= Non-Split Folio (Accompanying Guests) 102 = Split Folio (Share-Withs)102/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/ResSplitFolioTypeId
SmokingAllowedYSmoking Request Yes/No0 = No 1 = Yes1/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/PrefCollections/PrefCollection/HotelPref/SpecRequestPref[@SmokingAllowed=“1”]
SpecRequestPrefNSpecial RequestsGuest requests King Bed/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/PrefCollections/PrefCollection/HotelPref/SpecRequestPref
PhysChallFeaturePrefYHandicap Access Required Flag0 = No 1 = Yes0/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/PrefCollections/PrefCollection/HotelPref/PhysChallFeaturePref@PhysChallFeature
MembershipIDNUse Hyatt Gold Passport/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo/Memberships
PaymentTypeYType of PaymentCredit Card = cc Other Payment = otherCC/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/PaymentType
Note: If PaymentType=cc, then complete the following three parameters with the prefix “cc” in them and skip the seven tags which are prefixed with “oPay”. Similarly, if PaymentType=other, then skip the four parameters prefixed with “cc” and complete the seven “oPay”-prefixed parameters.
CardTypeYVisa = VI MasterCard = MC American Express = AX Diners Club = DC Discover = DSVI/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo/Guarantee/GuaranteesAccepted/GuaranteeAccepted/PaymentCard@CardCode
CardNumberYCredit card number; no spaces4444333322221111/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo/Guarantee/GuaranteesAccepted/GuaranteeAccepted/PaymentCard@CardNumber
ExpireDateYCredit Card Expiration Date1130/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo/Guarantee/GuaranteesAccepted/GuaranteeAccepted/PaymentCard@ExpireDate
CardHolderNameYAlexander Thomson/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo/Guarantee/GuaranteesAccepted/GuaranteeAccepted/PaymentCard/CardHolderName
oPayAmtYAmount paid105.99/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayAmt@Amount
oPayDateYPayment date in format YYYY-MM-DD2013-07-18/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayDate
oPayReferenceNumYExternal Reference Number, if any.ABC-123/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayReferenceNum
oPayCheckNumYCheck number.6549/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayCheckNum
oPayReceivedYFlag acknowledging whether payment was received; 0 = no, 1 = yes.1/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayReceived
oPayCommentsYComments; use this parameter to signify “bill-to-master”Attendee lodging charges being billed to master account/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayComments
oPayNameYName of person on payment.Credit Card Name/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayName
Note: Complete the following BillTo information regardless of payment type chosen above.
OPayNameYBill To Last NameJones/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayName
OPayNameYBill To Middle InitialM/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayName
OPayNameYBill To First NameSam/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayName
AddressLineYBill To Address Line 1123 Main Street/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OBillAddress/AddressLine
AddressLineYBill To Address Line 2Apt. 1/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OBillAddress/AddressLine
CityNameYPortsmouth/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OBillAddress/CityName
StateProvY2-letter State/Province codeNH/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OBillAddress/StateProv
PostalCodeYZip / Postal Code03801/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OBillAddress/PostalCode
CountryNameYCountry Code - ISO 3166 2-letter code (e.g., US)US/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OBillAddress/CountryName@Code
PhoneNumberYBill to Phone Number/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/BillPhone@PhoneNumber
Additional Guests
SurnameYLast name of first additional guest.Bailey/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/PersonName/Surname
MiddleNameNMiddle initial of first additional guest.T/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/PersonName/MiddleName
GivenNameYFirst name of first additional guest.Baxter/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/PersonName/GivenName
NamePrefixYTitle of first additional guest.Mr./CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/PersonName/NamePrefix
EmployeeInfoNBusiness Title / Position of first additional guest.Analyst/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/EmployeeInfo
CompanyNameNCompany / Organization of first additional guest.Cvent Solutions Inc./CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/CompanyInfo/CompanyName
Division2NName of division of first additional guest.
AddressLineYAddress line 1 of first additional guest.1 Cate Street/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Address/AddressLine
AddressLineNAddress line 2 of first additional guest.4th Floor/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Address/AddressLine
CityNameYCity of first additional guest.Portsmouth/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Address/CityName
StateProvY2-letter code; state abbreviation of first additional guest.NH/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Address/StateProv
PostalCodeYZip code of first additional guest.03802/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Address/PostalCode
CountryNameYISO 3166 2-letter code (e.g., US); country code for first additional guest.US/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Address/CountryName@Code
TelephoneYBusiness Telephone Number of first additional guest.603-555-1212/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Telephone[@PhoneTechType=“1”]/@ PhoneNumber
TelephoneYFax Number of first additional guest.603-555-1213/CreateReservationRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Telephone[@PhoneTechType=“3”]/@ PhoneNumber
Last updated on