Developer DocumentationLegacy APIRegLink APIsField MappingsCreate Bridge Mapping (Browser-Based and SOAP)
REST ParameterRequiredInclude as Best PracticeDescriptionAdditional CommentsSample DataXpath for XML Message
UserNameYUsername assigned by Cvent Passkey that has been granted API access.reglinkapi/CreateBridgeRQ/Security/Login/UserName
PasswordYPassword associated with API Username.passkey1/CreateBridgeRQ/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/CreateBridgeRQ/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.03/CreateBridgeRQ/Message/Version
ModeYCommunication Mode. Synchronous is the only mode supported for this API call.Synchronous=SS/CreateBridgeRQ/Message/Mode
OPYAPI Operation/Message TypeCreateBridgeHTTP/CreateBridgeRQ/Message/OP
DestinationYNo redirect. A value of “02” must be used for all API calls.02N/A
LocaleNAttendee’s preferred locale/languageIf an event is configured for multi-language support, this parameter allows the applicable attendee website to be invoked in the attendee’s preferred locale/language. The following locales are supported by Cvent Passkey allows the applicable attendee website to be invoked in the attendee’s preferred locale/language. The following locales are supported by Cvent Passkey: US English: EN_US CA English: EN_CA Deutsch: DE_DE Español(US): ES_DO Français (CA): FR_CA Français (FR): FR_FR Polski: PL_PL Português (BR): PT_BR Português (PT): PT_PT UK English: EN_GB ภาษาไทย (ไทย): TH_TH 中问(简体): ZH_CN 日本語 (にほんご): JA_JP 한국어: KO_KOEN_US/CreateBridgeRQ/Message/Locale
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/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/EventID
EventCodeYThis 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/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/AttendeeCode
BlockIDN/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/BlockID
HotelIDY
ExtReferenceIDNExternal Registration company record identifier (e.g., registration confirmation number)ABC-123/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/ExtReferenceID
LastNameYAttendee’s Last NameSmith/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/PersonName/Surname
MiddleInitialNAttendee’s Middle NameP/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/PersonName/MiddleName
FirstNameYAttendee’s First NameSimon/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/PersonName/GivenName
TitleNYAttendee’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./CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/PersonName/NameTitle
OrganizationNYAttendee’s Company or OrganizationCvent Solutions, Inc./CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/CompanyInfo/CompanyName
PositionNYAttendee’s professional title/positionProduct Manager/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/EmployeeInfo
Address1NYAttendee’s Address Line 1221 Crescent Street/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Address/AddressLine
Address2NAttendee’s Address Line 2Building 17/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Address/AddressLine
CityNYAttendee’s CityWaltham/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Address/CityName
StateNYAttendee’s 2-letter State/Province codeMA/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Address/StateProv
ZipCodeNYAttendee’s Zip/Postal Code02453-123/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Address/PostalCode
CountryCodeNYISO 3166 2-letter codeUS/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Address/CountryName@Code
WorkPhoneNYAttendee’s Work Phone Number781-373-4100/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Telephone[@PhoneTechType=“1”]/@ PhoneNumber
FaxNumberNAttendee’s Fax Number781-547-5414/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Telephone[@PhoneTechType=“3”]/@ PhoneNumber
EmailAddressNYAttendee’s Email Addressnoreply@Cvent.com/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer/Email
ArrivalDateNArrival date in format YYYY-MM-DDDate from Training Sample Event/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo/TimeSpan/StartDateWindow@EarliestDate
DepartureDateNDeparture date in format YYYY-MM-DDDate from Training Sample Event/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo/TimeSpan/StartDateWindow@LatestDate
HowBookedNHow 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/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/HowBooked
ReceivedFromNText field available to track the origin of reservations created in Cvent Passkeyi.e. a Registration company nameA Reg Company, Inc./CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/ReceivedFrom
SpecialRequestsNAttendee Special RequestsGuest requests King Bed/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/PrefCollections/PrefCollection/HotelPref/SpecRequestPref
PhysChallNHandicap Access Required Flag0=No; 1=Yes0/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest/Profiles/ProfileInfo/Profile/PrefCollections/PrefCollection/HotelPref/PhysChallFeaturePref@PhysChallFeature
PaymentTypeNType of PaymentValue: CC; otherCC/CreateBridgeRQ/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.
N/AYVI=Visa, MC=MasterCard, AX=American Express, DC=Diners Club, Discover=DSVI/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo/Guarantee/GuaranteesAccepted/GuaranteeAccepted/PaymentCard@CardCode
N/AYCredit card number; no spaces4444333322221111/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo/Guarantee/GuaranteesAccepted/GuaranteeAccepted/PaymentCard@CardNumber
N/AYCredit Card Expiration Date1130/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGlobalInfo/Guarantee/GuaranteesAccepted/GuaranteeAccepted/PaymentCard@ExpireDate
oPayAmtYAmount paid105.99/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayAmt@Amount
oPayDateYPayment date in format YYYY-MM-DD2013-07-18/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayDate
oPayReferenceNumYExternal Reference Number, if any.ABC-123/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayReferenceNum
oPayCheckNumYCheck number.6549/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayCheckNum
oPayReceivedYFlag acknowledging whether payment was received; 0 = no, 1 = yes.1/CreateBridgeRQ/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/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayComments
oPayNameYName of person on payment.Credit Card Name/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayName
Note: Complete the following BillTo information regardless of payment type chosen above.
BillToLastNameNBill to Last NameJones/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayName
BillToMINBill to Middle Name/InitialM/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayName
BillToFirstNameNBill to First NameSam/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OPayName
BillToAddress1NBill to Address Line 1123 Main Street/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OBillAddress/AddressLine
BillToAddress2NBill to Address Line 2Apt. 1/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OBillAddress/AddressLine
BillToCityNBill to CityPortsmouth/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OBillAddress/CityName
BillToStateN2-letter State/Province codeNH/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OBillAddress/StateProv
BillToZipCodeNBill to Postal/Zip Code03801/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OBillAddress/PostalCode
BillToCountryCodeNISO 3166 2-letter codeUS/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/OtherPayment/OBillAddress/CountryName@Code
BillToPhoneNBill to Phone Number/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/TPA_Extensions/PK_Info/BillPhone@PhoneNumber
Additional Guests Note: A total of up to 9 guests may be sent using the parameter name and guest number conventions below
LastName2YLast name of first additional guest.White/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/PersonName/Surname
MiddleInitial2NMiddle initial of first additional guest.G/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/PersonName/MiddleName
FirstName2YYFirst name of first additional guest.Betty/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/PersonName/GivenName
Title2NYTitle of first additional guest.Ms.
Position2NYPosition of first additional guest.Analyst/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/EmployeeInfo
Organization2NYOrganization of first additional guest.Cvent Solutions Inc./CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/CompanyInfo/CompanyName
Division2NName of division of first additional guest.
Address12NYAddress line 1 of additional guest. This is NOT address line 12.9 Jones Avenue/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Address/AddressLine
Address22NAddress line 2 of additional guest. This is NOT address line 22.Suite 18/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Address/AddressLine
City2NYCity of first additional guest.Kittery/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Address/CityName
State2NY2-letter code; state abbreviation of additional guest.ME/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Address/StateProv
ZipCode2NYZip code of first additional guest.03905/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Address/PostalCode
CountryCode2NYISO 3166 2-letter code (e.g., US); country code for first additional guest.US/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Address/CountryName@Code
WorkPhone2NYWork phone number of first additional guest603-555-1212/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Telephone[@PhoneTechType=“1”]/@ PhoneNumber
FaxNumber2NFax number of first additional guest603-555-1213/CreateBridgeRQ/Data/OTA_HotelResRQ/HotelReservations/HotelReservation/ResGuests/ResGuest ResGuest[@ResGuestRPH=“2”]/Profiles/ProfileInfo/Profile/Customer/Telephone[@PhoneTechType=“3”]/@ PhoneNumber
Last updated on