Model representing an attendee to be updated in an event.
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
event |
AttendeeUpdateEvent | ✔️ | The ID of the event associated with the attendee. | |
contact |
AttendeeUpdateContact | ✔️ | The ID of the address book contact associated with the attendee. | |
invitationList |
Optional<AttendeeUpdateInvitationList> | ➖ | The ID of the invitation list associated with the attendee. | |
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-marketingwebsite |
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. |
administrator |
Optional<AttendeeUpdateAdministrator> | ➖ | The ID of the administrator contact whom registered this attendee. | |
admissionItem |
Optional<AttendeeUpdateAdmissionItem> | ➖ | The ID of the attendee's admission item. Required when registering, updating a registered attendee, or cancelling an attendee. | |
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 |
answers |
List<AttendeeAnswer> | ➖ | The list of answers to the attendee's registration questions. | |
sendEmail |
Optional<Boolean> | ➖ | True indicates a confirmation email should be sent to the attendee. Cancelled attendees will not receive emails as a result of this field. If this field is left blank, the event settings for confirmation emails will apply. | false |
status |
Optional<AttendeeUpdateStatus> | ➖ | Denotes the status of an attendee to be updated. No Response: The attendee was added to an invitation list but hasn't taken any action. Accepted: The attendee is registered for the event. Cancelled: The attendee's registration for the event is cancelled. Visited: The attendee visited the event's webpage but didn't finish registration. Declined: The attendee declined to attend the event. Pending Approval: When registration approval is enabled, this status indicates the attendee is still waiting to be approved by the planner. Denied Approval: When registration approval is enabled, this status indicates the attendee has been denied approval by the planner. The following status transitions are supported by this API: * No Response -> Visited * No Response -> Accepted * No Response -> Declined * No Response -> Pending Approval * Cancelled -> Accepted * Cancelled -> Pending Approval * Visited -> Accepted * Visited -> Pending Approval * Declined -> Accepted * Declined -> Pending Approval * Accepted -> Cancelled * Pending Approval -> Accepted * Pending Approval -> Denied Approval * Denied Approval -> Pending Approval |
Accepted |
registrationType |
Optional<AttendeeUpdateRegistrationType> | ➖ | The attendee's registration type. | |
invitedBy |
Optional<AttendeeInvitedBy> | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. Method by which the attendee was invited to the event. Note: This field is deprecated. Previous documentation incorrectly listed support for this feature. |
Planner-Invited |
responseMethod |
Optional<AttendeeResponseMethod> | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. Method by which attendee registered for the event. Note: This field is deprecated. Previous documentation incorrectly listed support for this feature. |
Self-Responded |