Event

Represents a calendar appointment event.

Supported Calls

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

Fields

Field	Details
AccountId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the related Account.
ActivityDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description If the Event IsAllDayEvent flag is set to `true` (indicating that it is an all day Event), then the Event due date information is contained in the ActivityDate field. This field is a date field with a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone. The timestamp is not relevant, and you should not attempt to alter it to account for any time zone differences. Label is Due Date Only. This field is required in version 12.0 and earlier if the IsAllDayEvent flag is set to `true`. The value for this field and StartDateTime must match, or one of them must be null.
ActivityDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description If the Event IsAllDayEvent flag is set to `false` (indicating that it is not an all day Event), then the Event due date information is contained in the ActivityDateTime field. This field is a regular Date/Time field with a relevant time portion. The time portion is always transferred in the Coordinated Universal Time (UTC) time zone. You need to translate the time portion to or from a local time zone for the user or the application, as appropriate. Label is Due Date Time. This field is required in version 12.0 and earlier if the IsAllDayEvent flag is set to `false`. The value for this field and StartDateTime must match, or one of them must be null.
CurrencyIsoCode	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization.
Description	Type textarea Properties Create, Nillable, Update Description Text description of the event. Limit: 32,000 characters.
Division	Type picklist Properties Filter, Group, Restricted picklist, Sort Description A logical segment of your organization’s data. Available only if the organization has the Division permission enabled.
DurationInMinutes	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The event length, in minutes. Note that even though this represents a temporal value, it is an integer type—not a dateTime type. This field is required in version 12.0 and earlier if IsAllDayEvent is false. In version 13.0 and later, this field is optional based on the following: If IsAllDayEvent is true, you can supply a value for either DurationInMinutes or EndDateTime. Supplying values in both fields is allowed if they evaluate to the same span of time. If both fields are null, the duration defaults to one day. If IsAllDayEvent is false, a value must be supplied for either DurationInMinutes or EndDateTime. Supplying values in both fields is allowed if they evaluate to the same span of time. If the multiday event feature is enabled, then API versions 13.0 and later support values greater than 1440 for the DurationInMinutes field. API versions 12.0 and earlier can’t access event objects whose DurationInMinutes is greater than 1440. For more information, see Multiday Events.
EndDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Available in version 13.0 and later. This field is optional based on the following: If IsAllDayEvent is true, you can supply a value for either DurationInMinutes or EndDateTime. Supplying values in both fields is allowed if they evaluate to the same span of time. If both fields are null, the duration defaults to one day. If IsAllDayEvent is false, a value must be supplied for either DurationInMinutes or EndDateTime. Supplying values in both fields is allowed if they evaluate to the same span of time.
GroupEventType	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Read-only. Available in API version 19.0 and later. The possible values are: `0` (Non–group event)—An event with no invitees. `1` (Group event)—An event with invitees. `2` (Proposed event)—An event created when a user requests a meeting with a contact, lead, or person account using the Salesforce user interface. When the user confirms the meeting, the proposed event becomes a group event. You can't create, edit or delete proposed events in the API. For more information, see “About Cloud Scheduler” in the Salesforce online help.
IsAllDayEvent	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the ActivityDate field (`true`) or the ActivityDateTime field (`false`) is used to define the date or time of the event. Label is All Day Event. See also DurationInMinutes and EndDateTime.
IsArchived	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the event has been archived.
IsChild	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the event is a child of another event (`true`) or not (`false`).
IsGroupEvent	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the event is a group event with multiple attendees (`true`) or not (`false`).
IsPrivate	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether users other than the creator of this event can (`false`) or can’t (`true`) see the event details when viewing the event user's calendar. However, users with the “View All Data” or “Modify All Data” permission can see private events in reports and searches, or when viewing other users' calendars. Private events can’t be associated with opportunities, accounts, cases, campaigns, contracts, leads, or contacts. Label is Private.
IsRecurrence	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Indicates whether the event is scheduled to repeat itself (`true`) or only occurs once (`false`). This is a read-only field when updating records, but not when creating them. If this field value is `true`, then RecurrenceEndDateOnly, RecurrenceStartDateTime, RecurrenceType, and any recurrence fields associated with the given recurrence type must be populated. Label is Create recurring series of events.
IsReminderSet	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the activityis a reminder (`true`) or not (`false`).
IsVisibleInSelfService	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether an event associated with an object can be viewed in the Customer Portal (`true`) or not (`false`).
Location	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The location of the event.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the user who owns the event. Label is Assigned to ID.
RecurrenceActivityId	Type reference Properties Filter, Group, Nillable, Sort Description Read-only. Not required on create. ID of the main record of the recurring event. Subsequent occurrences have the same value in this field.
RecurrenceDayOfMonth	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The day of the month on which the event repeats.
RecurrenceDayOfWeekMask	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The day or days of the week on which the event repeats. This field contains a bitmask. For each day of the week, the values are as follows: Sunday = `1` Monday = `2` Tuesday = `4` Wednesday = `8` Thursday = `16` Friday = `32` Saturday = `64` Multiple days are represented as the sum of their numerical values. For example, Tuesday and Thursday = 4 + 16 = 20.
RecurrenceEndDateOnly	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The last date on which the event repeats. For multiday recurring events, this is the day on which the last occurrence starts.
RecurrenceInstance	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The frequency of the recurring event. For example, `2nd` or `3rd`.
RecurrenceInterval	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The interval between recurring events.
RecurrenceMonthOfYear	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The month of the year on which the event repeats.
RecurrenceStartDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the recurring event begins. Must be a date and time before RecurrenceEndDateOnly.
RecurrenceTimeZoneSidKey	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The time zone associated with the recurring event. For example, “UTC-8:00” for Pacific Standard Time.
RecurrenceType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates how often the event repeats. For example, daily, weekly, or every Nth month (where “Nth” is defined in RecurrenceInstance).
ReminderDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Represents the time the reminder is scheduled to fire, if IsReminderSet is set to `true`. If it is set to `false`, then the user may have deselected the reminder checkbox in the Salesforce user interface, or the reminder has already fired at the time indicated by the value.
ShowAs	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates how this event appears when another user views the calendar: Busy, Out of Office, or Free Time. Label is Show Time As.
StartDateTime	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Available in version 13.0 and later. The start date and time of the event. If the Event IsAllDayEvent flag is set to true (indicating that it is an all day Event), then the Event start date information is contained in the StartDateTime field. This field is a date field with a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone. The timestamp is not relevant, and you should not attempt to alter it to account for any time zone differences. If the Event IsAllDayEvent flag is set to false (indicating that it is not an all day Event), then the Event start date information is contained in the StartDateTime field. The time portion is always transferred in the Coordinated Universal Time (UTC) time zone. You need to translate the time portion to or from a local time zone for the user or the application, as appropriate. If this field has a value, then ActivityDate and ActivityDateTime must either be null or match the value of this field.
Subject	Type combobox Properties Create, Filter, Nillable, Sort, Update Description The subject line of the event, such as Call, Email, or Meeting. Limit: 255 characters.
Type	Type picklist Properties Create, Filter, Nillable, Update Description The type of event, such as Call, Email, or Meeting.
WhatId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of a related Account, Opportunity, Campaign, Case, or custom object. Label is Opportunity/Account ID.
WhoId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of a related Contact or Lead. If the WhoId refers to a lead, then the WhatId field must be empty. Label is Contact/Lead ID.

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.

When querying for events with a specific due date, you must filter on both the ActivityDateTime and ActivityDate fields. For example to find all events with a due date of February 14, 2003, you need two filters:

One filter with the ActivityDate field equal to the Coordinated Universal Time (UTC) time zone on February 14, 2003.
One filter with the ActivityDateTime field 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.

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.

Multiday Events

Multiday events are available in version 13.0 and later. Also, in earlier versions SOQL queries do not return multiday events.
Multiday events are enabled through the user interface at Your Name | Setup | Customize | Activities | Activity Settings.
If the multiday event feature is enabled, then API versions 13.0 and later support values greater than 1440 for the DurationInMinutes field. API versions 12.0 and earlier can’t access event objects whose DurationInMinutes is greater than 1440.
Multiday events can’t exceed 14 days.

Recurring Events

Recurring events are available in version 7.0 and later.
After an event is created, it can’t be changed from recurring to nonrecurring or vice versa.
When you delete a recurring event series through the API, all past and future events in the series are removed. However, when you delete a recurring event series through the user interface, only future occurrences are removed.
When creating a recurring event series, the duration of the event must be 24 hours or less (either the DurationInMinutes or the difference between RecurrenceStartDateTime and EndDateTime be greater than 24 hours). Once the recurring event series is created, you can extend the length of individual occurrences beyond 24 hours if Multiday events are enabled; see Multiday Events.
If IsRecurrence is true, then RecurrenceStartDateTime, RecurrenceEndDateOnly, RecurrenceType, and any properties associated with the given recurrence type (see the following table) must be populated.

The following table describes the usage of recurrence fields. Each recurrence type must have all of its properties set. All unused properties must be set to null.

RecurrenceType Value	Properties	Example Pattern
RecursDaily	RecurrenceInterval	Every second day
RecursEveryWeekday	RecurrenceDayOfWeekMask	Every weekday - can’t be Saturday or Sunday
RecursMonthly	RecurrenceDayOfMonth RecurrenceInterval	Every second month, on the third day of the month
RecursMonthlyNth	RecurrenceInterval RecurrenceInstance RecurrenceDayOfWeekMask	Every second month, on the last Friday of the month
RecursWeekly	RecurrenceInterval RecurrenceDayOfWeekMask	Every three weeks on Wednesday and Friday
RecursYearly	RecurrenceDayOfMonth RecurrenceMonthOfYear	Every March on the twenty-sixth day of the month
RecursYearlyNth	RecurrenceDayOfWeekMask RecurrenceInstanceRecurrenceMonthOfYear	The first Saturday in every October