EventRelation

Supported Calls

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

Fields

Usage

• Invitee related lists display slightly different content. In the Salesforce mobile app, the invitee related list includes invitees only, whereas in the full site, it also includes the event owner. To reproduce the full site functionality in the Salesforce mobile app, use the following API queries.

  If you use Shared Activities in your Salesforce org, use this query:

  where Event_Id is the child event’s ID.

  If you don’t use Shared Activities, use this query:

  These queries get the main event’s relations and display them for the given child event. To further filter the results, add a WHERE clause.

Assigning resource attendance status

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.

Create an invitee if Shared Activities is enabled (or during the process of enabling it or rolling back)

If the invitee is already a contact or lead, update IsInvitee to true.

If the invitee is not already a contact or lead, create an EventRelation object for the invitee with IsInvitee set to true.

Create an invitee if Shared Activities is not enabled

Create an EventRelation object for the invitee.

Insert a contact or lead relation

Determine what events a given invitee is attending

To determine all the events that a particular person is attending during a given time period (for example, next week), you can have a client application query the Event object for a given date range, iterate through the results, and, for each event, query the EventRelation object to determine whether the particular person (RelationId) has accepted an invitation to that event.

Insert an invitee relation

If isParent, isWhat and IsInvitee are not set, and RelationId is a contact, lead, user, or calendar, IsInvitee defaults to true. This means if an EventRelation isn’t specifically inserted as a relation to a contact or lead, it’s treated as an Invitee relation by default.

Query relations to a contact or a lead

Query invitee relations

Update an invitee relation to a contact or lead invitee relation

Update a contact or lead relation to a contact or lead invitee relation

Reproduce invitee related list functionality in the Salesforce mobile app

Invitee related lists display slightly different content in the Salesforce mobile app and the full site. In the app, the invitee related list includes invitees only, whereas in the full site, it also includes the event owner.

If you use Shared Activities in your Salesforce org, use the following query to reproduce the full site functionality in the Salesforce mobile app:

where Event_Id is the child event’s ID.

If you don’t use Shared Activities, use this query:

These queries get the main event’s relations and display them for the given child event. To further filter the results, add a WHERE clause.

Send email notifications

To send email notifications for a given event, query EventRelation for the event, iterate through the list, examine the status, and send email notifications to every person who accepted the invitation.

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. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

EventRelationChangeEvent (API version 44.0)

Change events are available for the object.