Represents a person (User, Contact, or Lead) who has been invited to attend an Event, or a scheduled resource (such as a conference room) associated
with the event.
Supported Calls
describeSObjects(), getDeleted(), getUpdated(), query(), retrieve()
Fields
| AttendeeId
|
- Type
- reference
- Properties
- Create, Filter, Group, Sort
- Description
- ID of the person (User, Contact, or Lead) invited to attend the Event, or the scheduled resource associated with this Event.
|
| EventId
|
- Type
- reference
- Properties
- Filter, Group, Sort
- Description
- ID of the Event.
|
| IsDeleted
|
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
- Indicates whether the object has been moved to the Recycle Bin
(true) or not (false). Label is Deleted.
|
| RespondedDate
|
- Type
- dateTime
- Properties
- Filter, Nillable, Sort
- Description
- Date and time when the attendee (invitee) responded.
|
| Response
|
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Optional text that the attendee entered when responding to the
event request.
|
| Status
|
- Type
- picklist
- Properties
- Filter, Group, Restricted picklist, Sort
- Description
- Attendee status. One of the following values:
- New—Invitee has received
the invitation but has not yet responded.
- Declined—Invitee has declined
to attend the event.
- Accepted—Invitee has accepted
the invitation to attend the event.
- Deleted—The invitation has
been deleted.
- Maybe—Reserved for future
use. This is not a valid value.
|
Usage
This object provides information
about who has been invited to attend a particular event and their
response to that invitation. A client application can, for example,
query this object for a given event, iterate through the list, examine
the status, and send email notifications to every person who accepted
the invitation.
To determine all the events that a particular
person is attending during a given time period (for example, next
week), a client application could query the Event object for a given date range, iterate through the results
and, for each event, query the EventAttendee object and determine whether the particular person (AttendeeId) has accepted an invitation to that event.