An event attendee.
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
created |
OffsetDateTime | ➖ | The ISO 8601 zoned date time when this record was created. | 2017-01-02T02:00:00Z |
createdBy |
Optional<String> | ➖ | The identifier of the user that created this record. | hporter |
lastModified |
OffsetDateTime | ➖ | The ISO 8601 zoned date time when this record was updated. | 2019-02-12T03:00:00Z |
lastModifiedBy |
Optional<String> | ➖ | The identifier of the user that last updated this record. | hporter |
id |
Optional<String> | ➖ | The ID of attendee in the given event. | |
event |
Optional<Attendee1Event> | ➖ | The attendee's associated event. | |
confirmationNumber |
Optional<String> | ➖ | The confirmation number is a code unique to each attendee. Cvent assigns one to the attendee upon registration for the event. Serves as proof of registration. | VNNDLJ6DKVK |
contact |
Optional<AttendeeContactInfo> | ➖ | Information about attendee contact added to an event. | |
checkedIn |
Optional<Boolean> | ➖ | True indicates the attendee checked in to the event. | true |
checkin |
OffsetDateTime | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. The date time when attendee was checked in to an event. Note: this field is deprecated. Please use the checkIn field instead. |
2018-01-13T02:00:00Z |
checkIn |
OffsetDateTime | ➖ | The ISO 8601 zoned date time when attendee was checked in to an event. | 2018-01-13T02:00:00Z |
checkOut |
OffsetDateTime | ➖ | The ISO 8601 zoned date time when attendee checked out from an event. | 2018-01-13T02:00:00Z |
duration |
Optional<Long> | ➖ | The duration, in milliseconds, the attendee was present at the event. | 4000 |
registrationPath |
Optional<Lookup> | ➖ | Lookup response object | |
invitationList |
Optional<NamedObject> | ➖ | A Named object | |
webLinks |
Optional<AttendeeWebLinks> | ➖ | Web links for an attendee. | |
registrationType |
Optional<Lookup> | ➖ | Lookup response object | |
referenceId |
Optional<String> | ➖ | The reference ID of an attendee. A planner determined string used to track which link attendee's used to reach the event registration. | refid-plannerside |
externalReferences |
List<ExternalReference> | ➖ | The details of an attendee in an external systems. | |
note |
Optional<String> | ➖ | A planner created note for an attendee, used to track details about the attendee. | Would like to sit near the front of the room for sessions. |
guest |
Optional<Boolean> | ➖ | True indicates the attendee is a guest of another attendee. | true |
deletedGuest |
Optional<Boolean> | ➖ | True indicates this attendee is a deleted guest. | false |
primaryId |
Optional<String> | ➖ | The ID of the primary attendee to whom this guest attendee is associated. Only applicable if this attendee is a guest. | |
group |
Optional<AttendeeGroup> | ➖ | An attendee group. | |
administrator |
Optional<Uuid> | ➖ | The reference to the related entity. Contains only the ID of the related entity. | |
unsubscribed |
Optional<Boolean> | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. DEPRECATED: True indicates this attendee is unsubscribed from this event's emails. They'll still receive emails triggered by their own actions (like registration modification). This field has been deprecated. Please use PUT /attendees/{id}/email-subscriptions instead. |
false |
status |
Optional<AttendeeStatus> | ➖ | This is used to denote the status of an attendee. | Accepted |
registeredAt |
OffsetDateTime | ➖ | The ISO 8601 zoned date time when attendee was registered. | 2018-01-13T02:00:00Z |
registrationLastModified |
OffsetDateTime | ➖ | The ISO 8601 zoned date time when attendee's registration was modified. This field is updated when there are changes to the registration, such as adding or removing products. | 2018-01-13T02:00:00Z |
registrationCancelledAt |
OffsetDateTime | ➖ | The ISO 8601 zoned date time when attendee registration was cancelled. | 2018-01-13T02:00:00Z |
invitedBy |
Optional<AttendeeInvitedBy1> | ➖ | Method by which the attendee was invited to the event. | Planner-Invited |
responseMethod |
Optional<AttendeeResponseMethod1> | ➖ | Represents the method by which an attendee registered for the event. - Administrator Responded: The invitee was registered by another contact acting as their administrator. - API-Responded: The invitee was registered through a custom process configured via an API integration. - Appointments Event Website: The invitee registered via an appointments event website. - Cvent Salesforce App: The invitee registered through an action in the Cvent Salesforce App. - External Registration: The attendee was registered through an external integration, such as Marketo. - Group Leader Responded: The invitee was registered by a group leader and added to a group. - Historical Import: The invitee's registration was imported into the event as historical data. - Imported: The invitee's registration was imported into the event. - No Response: The invitee has not registered. - On-site Responded: The invitee registered onsite using OnArrival's Kiosk Mode. - Planner-Imported: An account user imported the invitee's registration into the event. - Planner-Responded: An account user registered the invitee from the Cvent back-end or the planner-side of the OnArrival app. - Post Event: The invitee was registered by an account user after the event's end date or while the event was in Completed status. - Self-Responded: The invitee registered themselves through a weblink or invitation. Note: The responseMethod can only be set if the invitee's status is No Response. |
Self-Responded |
questions |
List<CustomFieldSchema> | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. A list of answers to contact custom fields. Note: This field is deprecated. Answers to custom contact fields can be found in the 'contact' model, customFields field instead. |
|
answers |
List<AttendeeAnswer> | ➖ | The list of answers to the registration questions. | |
admissionItem |
Optional<Attendee1Lookup> | ➖ | Contains details related to the attendee's admission item. | |
visibility |
Optional<AttendeeVisibility> | ➖ | Denotes the visibility of the attendee profile to other attendees. Private: Their profile is not visible. Public: Their profile is visible. | Private |
bio |
Optional<String> | ➖ | The attendee's biographical writeup. | In west Philadelphia, born and raised, on the playground is where I spent most of my days. |
showPopupNotification |
Optional<Boolean> | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. Notification setting in the Attendee Hub app or website. Note: This field is deprecated. Use allowPushNotification field instead. |
false |
websiteUrl |
Optional<String> | ➖ | An attendee's website URL, appears on their profile. | https://www.example.com |
allowPushNotifications |
Optional<Boolean> | ➖ | True indicates attendee will recieve push notifications for session-schedule changes, promotions and other event activities in the Attendee Hub app. | false |
allowAppointmentPushNotifications |
Optional<Boolean> | ➖ | True indicaites attendee will recieve push notifications for appointments related activities in the Attendee Hub app. | false |
testRecord |
Optional<Boolean> | ➖ | True indicates this attendee record was created as part of a test scenario. | false |
attendeeLastModified |
OffsetDateTime | ➖ | The ISO 8601 zoned date-time indicates when the attendee's non-contact properties were modified. Updates to the attendee's contact properties do not update this field. This field is updated when planners or attendees make changes to the attendee record, such as flagging as a participant. It is not updated for registration or product changes. | 2018-01-13T02:00:00Z |
appointmentGroups |
List<AppointmentGroup> | ➖ | List of appointment groups associated with attendee. These control permissions and visibility in appointments associated with the event. | |
credit |
Optional<Double> | ➖ | The amount of credit associated with the attendee. | 10 |