event resource type

An event in a calendar.

This resource supports:

  • Adding your own data to custom properties using extensions.
  • Using delta query to track incremental additions, deletions, and updates, by providing a delta function.

Methods

Method Return Type Description
List events event collection Retrieve a list of event objects in the user's mailbox. The list contains single instance meetings and series masters.
Create event event Create a new event by posting to the instances collection.
Get event event Read properties and relationships of event object.
Update event Update event object.
Delete None Delete event object.
accept None Accept the specified event.
tentativelyAccept None Tentatively accept the specified event.
decline None Decline invitation to the specified event.
delta event collection Get a set of events that have been added, deleted, or updated in a calendarView (a range of events) of the user's primary calendar.
dismissReminder None Dismiss the reminder for the specified event.
snoozeReminder None Snooze the reminder for the specified event.
List instances event collection Get the instances (occurrences) of an event for a specified time range. If the event is a SeriesMaster type, this returns the occurrences and exceptions of the event in the specified time range.
Attachments
List attachments attachment collection Get all attachments on an event.
Add attachment attachment Add a new attachment to an event by posting to the attachments collection.
Open extensions
Create open extension openTypeExtension Create an open extension and add custom properties in a new or existing instance of a resource.
Get open extension openTypeExtension collection Get an open extension object or objects identified by name or fully qualified name.
Extended properties
Create single-value extended property event Create one or more single-value extended properties in a new or existing event.
Get event with single-value extended property event Get events that contain a single-value extended property by using $expand or $filter.
Create multi-value extended property event Create one or more multi-value extended properties in a new or existing event.
Get event with multi-value extended property event Get an event that contains a multi-value extended property by using $expand.

Properties

Property Type Description
attendees attendee collection The collection of attendees for the event.
body itemBody The body of the message associated with the event. It can be in HTML or text format.
bodyPreview String The preview of the message associated with the event. It is in text format.
categories String collection The categories associated with the event.
changeKey String Identifies the version of the event object. Every time the event is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object.
createdDateTime DateTimeOffset The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'
end dateTimeTimeZone The date, time, and time zone that the event ends.
hasAttachments Boolean Set to true if the event has attachments.
iCalUId String A unique identifier that is shared by all instances of an event across different calendars.
id String Read-only.
importance String The importance of the event: Low = 0, Normal = 1, High = 2. Possible values are: Low, Normal, High.
isAllDay Boolean Set to true if the event lasts all day.
isCancelled Boolean Set to true if the event has been canceled.
isOrganizer Boolean Set to true if the message sender is also the organizer.
isReminderOn Boolean Set to true if an alert is set to remind the user of the event.
lastModifiedDateTime DateTimeOffset The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'
location location The location of the event.
onlineMeetingUrl String A URL for an online meeting.
organizer recipient The organizer of the event.
originalEndTimeZone String The end time zone that was set when the event was created. A value of tzone://Microsoft/Customindicates that a legacy custom time zone was set in desktop Outlook.
originalStart DateTimeOffset The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'
originalStartTimeZone String The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.
recurrence patternedRecurrence The recurrence pattern for the event.
reminderMinutesBeforeStart Int32 The number of minutes before the event start time that the reminder alert occurs.
responseRequested Boolean Set to true if the sender would like a response when the event is accepted or declined.
responseStatus responseStatus Indicates the type of response sent in response to an event message.
sensitivity String Possible values are: Normal, Personal, Private, Confidential.
seriesMasterId String The categories assigned to the item.
showAs String The status to show: Free = 0, Tentative = 1, Busy = 2, Oof = 3, WorkingElsewhere = 4, Unknown = -1. Possible values are: Free, Tentative, Busy, Oof, WorkingElsewhere, Unknown.
start dateTimeTimeZone The date, time, and time zone that the event starts.
subject String The text of the event's subject line.
type String The event type: SingleInstance = 0, Occurrence = 1, Exception = 2, SeriesMaster = 3. Possible values are: SingleInstance, Occurrence, Exception, SeriesMaster.
webLink String The URL to open the event in Outlook Web App.

The event will open in the browser if you are logged in to your mailbox via Outlook Web App. You will be prompted to login if you are not already logged in with the browser.

This URL can be accessed from within an iFrame.

Relationships

Relationship Type Description
attachments attachment collection The collection of fileAttachment and itemAttachment attachments for the event. Navigation property. Read-only. Nullable.
calendar calendar The calendar that contains the event. Navigation property. Read-only.
extensions Extension collection The collection of open extensions defined for the event. Read-only. Nullable.
instances event collection The instances of the event. Navigation property. Read-only. Nullable.
multiValueExtendedProperties multiValueLegacyExtendedProperty collection The collection of multi-value extended properties defined for the event. Read-only. Nullable.
singleValueExtendedProperties singleValueLegacyExtendedProperty collection The collection of single-value extended properties defined for the event. Read-only. Nullable.

JSON representation

Here is a JSON representation of the resource

{
  "attendees": [{"@odata.type": "microsoft.graph.attendee"}],
  "body": {"@odata.type": "microsoft.graph.itemBody"},
  "bodyPreview": "string",
  "categories": ["string"],
  "changeKey": "string",
  "createdDateTime": "String (timestamp)",
  "end": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
  "hasAttachments": true,
  "iCalUId": "string",
  "id": "string (identifier)",
  "importance": "String",
  "isAllDay": true,
  "isCancelled": true,
  "isOrganizer": true,
  "isReminderOn": true,
  "lastModifiedDateTime": "String (timestamp)",
  "location": {"@odata.type": "microsoft.graph.location"},
  "onlineMeetingUrl": "string",
  "organizer": {"@odata.type": "microsoft.graph.recipient"},
  "originalEndTimeZone": "string",
  "originalStart": "String (timestamp)",
  "originalStartTimeZone": "string",
  "recurrence": {"@odata.type": "microsoft.graph.patternedRecurrence"},
  "reminderMinutesBeforeStart": 1024,
  "responseRequested": true,
  "responseStatus": {"@odata.type": "microsoft.graph.responseStatus"},
  "sensitivity": "String",
  "seriesMasterId": "string",
  "showAs": "String",
  "start": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
  "subject": "string",
  "type": "String",
  "webLink": "string",

  "attachments": [ { "@odata.type": "microsoft.graph.attachment" } ],
  "calendar": { "@odata.type": "microsoft.graph.calendar" },
  "instances": [ { "@odata.type": "microsoft.graph.event" }]

}

See also