Event

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Usage

Use Event to manage calendar appointments.

Querying and Filtering Events

Queries on events will be denied before they time out if they involve amounts of data that are deemed too large. In such cases, the exception code OPERATION_TOO_LARGE is returned. If you receive OPERATION_TOO_LARGE, refactor your query to return or scan a smaller amount of data.

Alternatively, in version 13.0 and later, you can find events with a specific due date by filtering on StartDateTime. For example, to find all events with a due date of February 14, 2003, filter with the StartDateTime greater than or equal to midnight on February 14, 2003 in the user's local time zone AND less than or equal to midnight on February 15, 2003 in the user's local time zone.

The EventId field of an EventRelation object always points to the master record. An invitee on a group event can query the EventRelation object to view the master record.

Event Series and Recurring Events

In Lightning Experience, events with multiple occurrences are called event series, and are indicated when the IsRecurrence2 field is set to true. In Salesforce Classic, events with multiple occurrences are called recurring events, and are indicated when the IsRecurrence field is set to true. Both fields can’t be set to true for the same event.

• Lightning Experience event series are available in API version 44.0 and later as read-only fields. Salesforce Classic recurring events are available in version 7.0 and later. In earlier versions, SOQL queries don’t return any Lightning Experience event series.
• After an event is created, you can’t change the values of IsRecurrence2 or IsRecurrence from true to false or vice versa.
• You can’t set fields associated with IsRecurrence2 for events where IsRecurrence is set to true, or vice versa.
• For Lightning Experience event series where IsRecurrence2 is true, if you’d like to delete a single or all remaining events, use the REST API call. For Salesforce Classic recurring events where IsRecurrence is true, all past and future events in the series are removed when you delete the recurring event series through the API. However, when you delete the recurring event series through the user interface, only future occurrences are removed.
• When creating a Salesforce Classic recurring event series, the duration of the event must be 24 hours or less. When the Salesforce Classic recurring event series is created, you can extend the length of individual occurrences beyond 24 hours if Multiday events are enabled; see Multiday Events.
• For Salesforce Classic recurring events, RecurrenceStartDateTime, RecurrenceEndDateOnly, RecurrenceType, and any properties associated with the given recurrence type (see the Recurrence Field Usage for Salesforce Classic Recurring Events table) must be populated.
• When updating a Salesforce Classic recurring event series, it’s not possible to update the EventRelation for the event series object and the EventRelation for the series object occurrences at the same time.
• Lightning Experience event series have no series ID, so it’s not possible to locate other occurrences in the series. In Salesforce Classic recurring events, you can use RecurrenceActivityId to locate other occurrences.
• For both Lightning Experience event series and Salesforce Classic recurring events, when a series repeats every day, month, or year, you can only schedule occurrences once per day, month, or year. The every week option lets you schedule occurrences multiple days per week.

Limits for Lightning Experience event series and limits for Salesforce Classic recurring events also apply.

This table describes the usage of recurrence fields for Salesforce Classic recurring events. Each recurrence type must have all of its properties set. All unused properties must be set to null.

Attendees, Invitees, and Resources

The field GroupEventType indicates that event participants are included on an event. You can add a resource to an event only when the resource is available. The only attendance status that can be assigned to resources is Accepted. Events can’t be saved when resources you’ve added aren’t available.

JunctionIdList

1public void createEventNew(Contact[] contacts) {
2	String[] contactIds = new String[contacts.size()];
3	for (int i = 0; i < contacts.size(); i++) {
4		contactIds[i] = contacts[i].getID();
5	}
6	Event event = new Event();
7	event.setSubject("New Event");
8	event.setEventWhoIds(contactIds);
9	SaveResult[] results = null;
10	try {
11		results = connection.create(new Event[] {
12			task
13		});
14	} catch (ConnectionException ce) {
15		ce.printStackTrace();
16	}
17}

Syncing Events with Lightning Sync

Attendee statuses (Accepted or Maybe, Declined, or No Response) sync from Microsoft® Exchange or Google to Salesforce, but not from Salesforce to Exchange or Google. Be wary of creating API flows that update attendee status in Salesforce for users set up to sync both ways. Eventually the original Exchange or Google status overrides the update made in Salesforce.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

EventFeed (API version 20.0)

Feed tracking is available for the object.