| REST Parameter | Required | Include as Best Practice | Description | Additional Comments | Sample Data |
|---|---|---|---|---|---|
| PartnerID | Y | Unique ID which represents the Partner Profile or “Organization” in Cvent Passkey. | Assigned to all new partners at the time of setup in production. | 136260 | |
| Version | Y | Identifies 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 | |
| Mode | Y | Communication Mode. Synchronous is the only mode supported for this API call. | Synchronous=S | S | |
| OP | Y | API Operation/Message Type | RegExpress consists of a single operation method - “CreateBridgeAndRedirectResWeb” | CreateBridgeAndRedirectResWeb | |
| Destination | Y | No redirect. A value of “02” must be used for this API call. | 02 | ||
| ExtReferenceID | Y | External 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 | ||
| EventID | Y | This 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 | ||
| EventCode | Y | This 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 | ||
| LastName | Y | Y | Attendee’s Last Name | Smith | |
| MiddleInitial | N | Attendee’s Middle Name | P | ||
| FirstName | N | Y | Attendee’s First Name | Simon | |
| Title | N | Y | Attendee’s title | 1. 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. |
| Organization | N | Y | Attendee’s Company or Organization | Cvent Solutions, Inc. | |
| Position | N | Y | Attendee’s professional title/position | Product Manager | |
| Address1 | N | Y | Attendee’s Address Line 1 | 221 Crescent Street | |
| Address2 | N | Attendee’s Address Line 1 | Building 17 | ||
| City | N | Y | Attendee’s City | Waltham | |
| State | N | Y | Attendee’s 2-letter State/Province code | MA | |
| ZipCode | N | Y | Attendee’s Zip/Postal Code | 02453 or | |
| 02453-1234 | 02453-1234 | 02453-1234 | 02453-1234 | 02453-1234 | 02453-1234 |
| CountryCode | N | Y | ISO 3166 2-letter code | US | |
| Locale | N | Attendee’s preferred locale/language | If 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 | |
| WorkPhone | N | Y | Attendee’s Work Phone Number | 781-373-4100 | |
| FaxNumber | N | Attendee’s Fax Number | 781-547-5414 | ||
| EmailAddress | N | Y | Attendee’s Email Address | noreply@Cvent.com | |
| ArrivalDate | N | Arrival date in format YYYY-MM-DD | Date from Training Sample Event | ||
| DepartureDate | N | Departure date in format YYYY-MM-DD | Date from Training Sample Event | ||
| ReceivedFrom | N | Text field available to track the origin of reservations created in Cvent Passkey | Registration company name | A Reg Company, Inc. | |
| SpecialRequests | N | Attendee Special Requests | Guest 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 | |||||
| LastName2 | Y | Y | Last name of first additional guest. | White | |
| MiddleInitial2 | N | Middle initial of first additional guest. | G | ||
| FirstName2 | N | Y | First name of first additional guest. | Betty | |
| Title2 | N | Y | Title of first additional guest. | Ms. | |
| Position2 | N | Y | Position of first additional guest. | Analyst | |
| Organization2 | N | Y | Organization of first additional guest. | Cvent Solutions, Inc. | |
| Division2 | N | Name of division of first additional guest. | |||
| Address12 | N | Y | Address line 1 of first additional guest. This is NOT address line 12. | 9 Jones Avenue | |
| Address22 | N | Address line 2 of first additional guest. This is NOT address line 22. | Suite 18 | ||
| City2 | N | Y | City of first additional guest. | Kittery | |
| State2 | N | Y | 2-letter code; state abbreviation of first additional guest. | ME | |
| ZipCode2 | N | Y | Zip/Postal code of first additional guest. | 03905 or | |
| 03905-1234 | 03905-1234 | 03905-1234 | 03905-1234 | 03905-1234 | |
| CountryCode2 | N | Y | ISO 3166 2-letter country code for first additional guest. | US | |
| WorkPhone2 | N | Y | Work phone number of first additional guest | 603-555-1212 | |
| FaxNumber2 | N | Fax number of first additional guest | 603-555-1213 |
Last updated on