REST ParameterRequiredInclude as Best PracticeDescriptionAdditional CommentsSample Data
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
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
ModeYCommunication Mode. Synchronous is the only mode supported for this API call.Synchronous=SS
OPYAPI Operation/Message TypeRegExpress consists of a single operation method - “CreateBridgeAndRedirectResWeb”CreateBridgeAndRedirectResWeb
DestinationYNo redirect. A value of “02” must be used for this API call.02
ExtReferenceIDYExternal Registration company unique record identifier (e.g., registration acknowledgement number) - This must be unique for each attendee/guest. A future enhancement to this API call will utilize this number to update existing information.987123
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
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
LastNameYYAttendee’s Last NameSmith
MiddleInitialNAttendee’s Middle NameP
FirstNameNYAttendee’s First NameSimon
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.
OrganizationNYAttendee’s Company or OrganizationCvent Solutions, Inc.
PositionNYAttendee’s professional title/positionProduct Manager
Address1NYAttendee’s Address Line 1221 Crescent Street
Address2NAttendee’s Address Line 1Building 17
CityNYAttendee’s CityWaltham
StateNYAttendee’s 2-letter State/Province codeMA
ZipCodeNYAttendee’s Zip/Postal Code02453 or
02453-123402453-123402453-123402453-123402453-123402453-1234
CountryCodeNYISO 3166 2-letter codeUS
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. Click here for a list of locales currently supported by Cvent Passkey.EN_US
WorkPhoneNYAttendee’s Work Phone Number781-373-4100
FaxNumberNAttendee’s Fax Number781-547-5414
EmailAddressNYAttendee’s Email Addressnoreply@Cvent.com
ArrivalDateNArrival date in format YYYY-MM-DDDate from Training Sample Event
DepartureDateNDeparture date in format YYYY-MM-DDDate from Training Sample Event
ReceivedFromNText field available to track the origin of reservations created in Cvent PasskeyRegistration company nameA Reg Company, Inc.
SpecialRequestsNAttendee Special RequestsGuest requests King Bed
Additional Guests Note: A total of up to 9 guests may be sent using the parameter name and guest number conventions below
LastName2YYLast name of first additional guest.White
MiddleInitial2NMiddle initial of first additional guest.G
FirstName2NYFirst name of first additional guest.Betty
Title2NYTitle of first additional guest.Ms.
Position2NYPosition of first additional guest.Analyst
Organization2NYOrganization of first additional guest.Cvent Solutions, Inc.
Division2NName of division of first additional guest.
Address12NYAddress line 1 of first additional guest. This is NOT address line 12.9 Jones Avenue
Address22NAddress line 2 of first additional guest. This is NOT address line 22.Suite 18
City2NYCity of first additional guest.Kittery
State2NY2-letter code; state abbreviation of first additional guest.ME
ZipCode2NYZip/Postal code of first additional guest.03905 or
03905-123403905-123403905-123403905-123403905-1234
CountryCode2NYISO 3166 2-letter country code for first additional guest.US
WorkPhone2NYWork phone number of first additional guest603-555-1212
FaxNumber2NFax number of first additional guest603-555-1213
Last updated on