Skip to content

Microsoft: Me calendar group schemas

6 Microsoft schemas with complete fields and constraints.

← Me calendar group operations · All schemas

Create Calendar Group — request body — body

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get rule — response body — @odata type, id
$ (allOf 2)objectAll variants apply
$ (allOf 2).@odata.typestringOptional
$ (allOf 2).calendarsarrayOptionalThe calendars in the calendar group. Navigation property. Read-only. Nullable.
$ (allOf 2).calendars[]ModelEach itemExpand Create Calendar Group — request body — body @odata type, calendars, change Key, class Id, name calendars item
$ (allOf 2).changeKeyJSONOptional
$ (allOf 2).changeKey (anyOf 1)stringAlternativeIdentifies the version of the calendar group. Every time the calendar group is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.
$ (allOf 2).changeKey (anyOf 2)nullAlternative
$ (allOf 2).classIdJSONOptional
$ (allOf 2).classId (anyOf 1)stringAlternativeThe class identifier. Read-only.
Format: uuid
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
$ (allOf 2).classId (anyOf 2)nullAlternative
$ (allOf 2).nameJSONOptional
$ (allOf 2).name (anyOf 1)stringAlternativeThe group name.
$ (allOf 2).name (anyOf 2)nullAlternative

Referenced models: Get rule — response body — @odata type, id, Create Calendar Group — request body — body @odata type, calendars, change Key, class Id, name calendars item

Create Calendar Group — request body — body @odata type, calendars, change Key, class Id, name calendars item

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get rule — response body — @odata type, id
$ (allOf 2)objectAll variants apply
$ (allOf 2).@odata.typestringOptional
$ (allOf 2).allowedOnlineMeetingProvidersarrayOptionalRepresent the online meeting service providers that can be used to create online meetings in this calendar. The possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.
$ (allOf 2).allowedOnlineMeetingProviders[]JSONEach item
$ (allOf 2).allowedOnlineMeetingProviders[] (anyOf 1)stringAlternativeOne of: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness
$ (allOf 2).allowedOnlineMeetingProviders[] (anyOf 2)JSONAlternative
$ (allOf 2).allowedOnlineMeetingProviders[] (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).allowedOnlineMeetingProviders[] (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).canEditJSONOptional
$ (allOf 2).canEdit (anyOf 1)booleanAlternativetrue if the user can write to the calendar, false otherwise. This property is true for the user who created the calendar. This property is also true for a user who shared a calendar and granted write access.
$ (allOf 2).canEdit (anyOf 2)nullAlternative
$ (allOf 2).canShareJSONOptional
$ (allOf 2).canShare (anyOf 1)booleanAlternativetrue if the user has permission to share the calendar, false otherwise. Only the user who created the calendar can share it.
$ (allOf 2).canShare (anyOf 2)nullAlternative
$ (allOf 2).canViewPrivateItemsJSONOptional
$ (allOf 2).canViewPrivateItems (anyOf 1)booleanAlternativeIf true, the user can read calendar items that have been marked private, false otherwise.
$ (allOf 2).canViewPrivateItems (anyOf 2)nullAlternative
$ (allOf 2).changeKeyJSONOptional
$ (allOf 2).changeKey (anyOf 1)stringAlternativeIdentifies the version of the calendar object. Every time the calendar is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.
$ (allOf 2).changeKey (anyOf 2)nullAlternative
$ (allOf 2).colorJSONOptionalSpecifies the color theme to distinguish the calendar from other calendars in a UI. The property values are: auto, lightBlue, lightGreen, lightOrange, lightGray, lightYellow, lightTeal, lightPink, lightBrown, lightRed, maxColor.
$ (allOf 2).color (anyOf 1)stringAlternativeOne of: auto, lightBlue, lightGreen, lightOrange, lightGray, lightYellow, lightTeal, lightPink, lightBrown, lightRed, maxColor
$ (allOf 2).color (anyOf 2)JSONAlternative
$ (allOf 2).color (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).color (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).defaultOnlineMeetingProviderJSONOptionalThe default online meeting provider for meetings sent from this calendar. The possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.
$ (allOf 2).defaultOnlineMeetingProvider (anyOf 1)stringAlternativeOne of: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness
$ (allOf 2).defaultOnlineMeetingProvider (anyOf 2)JSONAlternative
$ (allOf 2).defaultOnlineMeetingProvider (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).defaultOnlineMeetingProvider (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).hexColorJSONOptional
$ (allOf 2).hexColor (anyOf 1)stringAlternativeThe calendar color, expressed in a hex color code of three hexadecimal values, each ranging from 00 to FF and representing the red, green, or blue components of the color in the RGB color space. If the user has never explicitly set a color for the calendar, this property is empty. Read-only.
$ (allOf 2).hexColor (anyOf 2)nullAlternative
$ (allOf 2).isDefaultCalendarJSONOptional
$ (allOf 2).isDefaultCalendar (anyOf 1)booleanAlternativetrue if this is the default calendar where new events are created by default, false otherwise.
$ (allOf 2).isDefaultCalendar (anyOf 2)nullAlternative
$ (allOf 2).isRemovableJSONOptional
$ (allOf 2).isRemovable (anyOf 1)booleanAlternativeIndicates whether this user calendar can be deleted from the user mailbox.
$ (allOf 2).isRemovable (anyOf 2)nullAlternative
$ (allOf 2).isTallyingResponsesJSONOptional
$ (allOf 2).isTallyingResponses (anyOf 1)booleanAlternativeIndicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.
$ (allOf 2).isTallyingResponses (anyOf 2)nullAlternative
$ (allOf 2).nameJSONOptional
$ (allOf 2).name (anyOf 1)stringAlternativeThe calendar name.
$ (allOf 2).name (anyOf 2)nullAlternative
$ (allOf 2).ownerJSONOptionalIf set, this represents the user who created or added the calendar. For a calendar that the user created or added, the owner property is set to the user. For a calendar shared with the user, the owner property is set to the person who shared that calendar with the user.
$ (allOf 2).owner (anyOf 1)ModelAlternativeExpand Get calendar Permission — response body — @odata type, allowed Roles, email Address, is Inside Organization, is Removable, role email Address @odata type, address, name
$ (allOf 2).owner (anyOf 2)JSONAlternative
$ (allOf 2).owner (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).owner (anyOf 2) (anyOf 2)nullAlternative

Referenced models: Get calendar Permission — response body — @odata type, allowed Roles, email Address, is Inside Organization, is Removable, role email Address @odata type, address, name, Get rule — response body — @odata type, id

Create Calendar — request body — body

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get rule — response body — @odata type, id
$ (allOf 2)objectAll variants apply
$ (allOf 2).@odata.typestringOptional
$ (allOf 2).allowedOnlineMeetingProvidersarrayOptionalRepresent the online meeting service providers that can be used to create online meetings in this calendar. The possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.
$ (allOf 2).allowedOnlineMeetingProviders[]JSONEach item
$ (allOf 2).allowedOnlineMeetingProviders[] (anyOf 1)stringAlternativeOne of: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness
$ (allOf 2).allowedOnlineMeetingProviders[] (anyOf 2)JSONAlternative
$ (allOf 2).allowedOnlineMeetingProviders[] (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).allowedOnlineMeetingProviders[] (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).calendarPermissionsarrayOptionalThe permissions of the users with whom the calendar is shared.
$ (allOf 2).calendarPermissions[]ModelEach itemExpand Create calendar Permission — request body — body
$ (allOf 2).calendarViewarrayOptionalThe calendar view for the calendar. Navigation property. Read-only.
$ (allOf 2).calendarView[]ModelEach itemExpand Create Calendar — request body — body @odata type, allowed Online Meeting Providers, calendar Permissions, calendar View, can Edit, can Share, can View Private Items, change Key, color, default Online Meeting Provider, events, hex Color, is Default Calendar, is Removable, is Tallying Responses, multi Value Extended Properties, name, owner, single Value Extended Properties events item
$ (allOf 2).canEditJSONOptional
$ (allOf 2).canEdit (anyOf 1)booleanAlternativetrue if the user can write to the calendar, false otherwise. This property is true for the user who created the calendar. This property is also true for a user who shared a calendar and granted write access.
$ (allOf 2).canEdit (anyOf 2)nullAlternative
$ (allOf 2).canShareJSONOptional
$ (allOf 2).canShare (anyOf 1)booleanAlternativetrue if the user has permission to share the calendar, false otherwise. Only the user who created the calendar can share it.
$ (allOf 2).canShare (anyOf 2)nullAlternative
$ (allOf 2).canViewPrivateItemsJSONOptional
$ (allOf 2).canViewPrivateItems (anyOf 1)booleanAlternativeIf true, the user can read calendar items that have been marked private, false otherwise.
$ (allOf 2).canViewPrivateItems (anyOf 2)nullAlternative
$ (allOf 2).changeKeyJSONOptional
$ (allOf 2).changeKey (anyOf 1)stringAlternativeIdentifies the version of the calendar object. Every time the calendar is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.
$ (allOf 2).changeKey (anyOf 2)nullAlternative
$ (allOf 2).colorJSONOptionalSpecifies the color theme to distinguish the calendar from other calendars in a UI. The property values are: auto, lightBlue, lightGreen, lightOrange, lightGray, lightYellow, lightTeal, lightPink, lightBrown, lightRed, maxColor.
$ (allOf 2).color (anyOf 1)stringAlternativeOne of: auto, lightBlue, lightGreen, lightOrange, lightGray, lightYellow, lightTeal, lightPink, lightBrown, lightRed, maxColor
$ (allOf 2).color (anyOf 2)JSONAlternative
$ (allOf 2).color (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).color (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).defaultOnlineMeetingProviderJSONOptionalThe default online meeting provider for meetings sent from this calendar. The possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.
$ (allOf 2).defaultOnlineMeetingProvider (anyOf 1)stringAlternativeOne of: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness
$ (allOf 2).defaultOnlineMeetingProvider (anyOf 2)JSONAlternative
$ (allOf 2).defaultOnlineMeetingProvider (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).defaultOnlineMeetingProvider (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).eventsarrayOptionalThe events in the calendar. Navigation property. Read-only.
$ (allOf 2).events[]ModelEach itemExpand Create Calendar — request body — body @odata type, allowed Online Meeting Providers, calendar Permissions, calendar View, can Edit, can Share, can View Private Items, change Key, color, default Online Meeting Provider, events, hex Color, is Default Calendar, is Removable, is Tallying Responses, multi Value Extended Properties, name, owner, single Value Extended Properties events item
$ (allOf 2).hexColorJSONOptional
$ (allOf 2).hexColor (anyOf 1)stringAlternativeThe calendar color, expressed in a hex color code of three hexadecimal values, each ranging from 00 to FF and representing the red, green, or blue components of the color in the RGB color space. If the user has never explicitly set a color for the calendar, this property is empty. Read-only.
$ (allOf 2).hexColor (anyOf 2)nullAlternative
$ (allOf 2).isDefaultCalendarJSONOptional
$ (allOf 2).isDefaultCalendar (anyOf 1)booleanAlternativetrue if this is the default calendar where new events are created by default, false otherwise.
$ (allOf 2).isDefaultCalendar (anyOf 2)nullAlternative
$ (allOf 2).isRemovableJSONOptional
$ (allOf 2).isRemovable (anyOf 1)booleanAlternativeIndicates whether this user calendar can be deleted from the user mailbox.
$ (allOf 2).isRemovable (anyOf 2)nullAlternative
$ (allOf 2).isTallyingResponsesJSONOptional
$ (allOf 2).isTallyingResponses (anyOf 1)booleanAlternativeIndicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.
$ (allOf 2).isTallyingResponses (anyOf 2)nullAlternative
$ (allOf 2).multiValueExtendedPropertiesarrayOptionalThe collection of multi-value extended properties defined for the calendar. Read-only. Nullable.
$ (allOf 2).multiValueExtendedProperties[]ModelEach itemExpand Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count multi Value Extended Properties item
$ (allOf 2).nameJSONOptional
$ (allOf 2).name (anyOf 1)stringAlternativeThe calendar name.
$ (allOf 2).name (anyOf 2)nullAlternative
$ (allOf 2).ownerJSONOptionalIf set, this represents the user who created or added the calendar. For a calendar that the user created or added, the owner property is set to the user. For a calendar shared with the user, the owner property is set to the person who shared that calendar with the user.
$ (allOf 2).owner (anyOf 1)ModelAlternativeExpand Get calendar Permission — response body — @odata type, allowed Roles, email Address, is Inside Organization, is Removable, role email Address @odata type, address, name
$ (allOf 2).owner (anyOf 2)JSONAlternative
$ (allOf 2).owner (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).owner (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).singleValueExtendedPropertiesarrayOptionalThe collection of single-value extended properties defined for the calendar. Read-only. Nullable.
$ (allOf 2).singleValueExtendedProperties[]ModelEach itemExpand Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count single Value Extended Properties item

Referenced models: Get calendar Permission — response body — @odata type, allowed Roles, email Address, is Inside Organization, is Removable, role email Address @odata type, address, name, Get rule — response body — @odata type, id, Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count multi Value Extended Properties item, Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count single Value Extended Properties item, Create calendar Permission — request body — body, Create Calendar — request body — body @odata type, allowed Online Meeting Providers, calendar Permissions, calendar View, can Edit, can Share, can View Private Items, change Key, color, default Online Meeting Provider, events, hex Color, is Default Calendar, is Removable, is Tallying Responses, multi Value Extended Properties, name, owner, single Value Extended Properties events item

Create Calendar — request body — body @odata type, allowed Online Meeting Providers, calendar Permissions, calendar View, can Edit, can Share, can View Private Items, change Key, color, default Online Meeting Provider, events, hex Color, is Default Calendar, is Removable, is Tallying Responses, multi Value Extended Properties, name, owner, single Value Extended Properties events item

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get event — response body — @odata type, categories, change Key, created Date Time, id, last Modified Date Time
$ (allOf 2)objectAll variants apply
$ (allOf 2).@odata.typestringOptionalDefault: #microsoft.graph.event
$ (allOf 2).allowNewTimeProposalsJSONOptional
$ (allOf 2).allowNewTimeProposals (anyOf 1)booleanAlternativetrue if the meeting organizer allows invitees to propose a new time when responding; otherwise, false. Optional. The default is true.
$ (allOf 2).allowNewTimeProposals (anyOf 2)nullAlternative
$ (allOf 2).attendeesarrayOptionalThe collection of attendees for the event.
$ (allOf 2).attendees[]ModelEach itemExpand Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link attendees item
$ (allOf 2).bodyJSONOptionalThe body of the message associated with the event. It can be in HTML or text format.
$ (allOf 2).body (anyOf 1)ModelAlternativeExpand Create message — request body — body @odata type, attachments, bcc Recipients, body, body Preview, cc Recipients, conversation Id, conversation Index, extensions, flag, from, has Attachments, importance, inference Classification, internet Message Headers, internet Message Id, is Delivery Receipt Requested, is Draft, is Read, is Read Receipt Requested, multi Value Extended Properties, parent Folder Id, received Date Time, reply To, sender, sent Date Time, single Value Extended Properties, subject, to Recipients, unique Body, web Link body @odata type, content, content Type
$ (allOf 2).body (anyOf 2)JSONAlternative
$ (allOf 2).body (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).body (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).bodyPreviewJSONOptional
$ (allOf 2).bodyPreview (anyOf 1)stringAlternativeThe preview of the message associated with the event. It's in text format.
$ (allOf 2).bodyPreview (anyOf 2)nullAlternative
$ (allOf 2).cancelledOccurrencesarrayOptionalContains occurrenceId property values of canceled instances in a recurring series, if the event is the series master. Instances in a recurring series that are canceled are called canceled occurences.Requires $select to retrieve. Only returned in a Get operation that specifies the ID (seriesMasterId property value) of a series master event.
$ (allOf 2).cancelledOccurrences[]stringEach item
$ (allOf 2).endJSONOptionalThe date, time, and time zone that the event ends. By default, the end time is in UTC.
$ (allOf 2).end (anyOf 1)ModelAlternativeExpand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time
$ (allOf 2).end (anyOf 2)JSONAlternative
$ (allOf 2).end (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).end (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).hasAttachmentsJSONOptional
$ (allOf 2).hasAttachments (anyOf 1)booleanAlternativeSet to true if the event has attachments.
$ (allOf 2).hasAttachments (anyOf 2)nullAlternative
$ (allOf 2).hideAttendeesJSONOptional
$ (allOf 2).hideAttendees (anyOf 1)booleanAlternativeWhen set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. The default is false.
$ (allOf 2).hideAttendees (anyOf 2)nullAlternative
$ (allOf 2).iCalUIdJSONOptional
$ (allOf 2).iCalUId (anyOf 1)stringAlternativeA unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.
$ (allOf 2).iCalUId (anyOf 2)nullAlternative
$ (allOf 2).importanceJSONOptionalThe importance of the event. The possible values are: low, normal, high.
$ (allOf 2).importance (anyOf 1)stringAlternativeOne of: low, normal, high
$ (allOf 2).importance (anyOf 2)JSONAlternative
$ (allOf 2).importance (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).importance (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).isAllDayJSONOptional
$ (allOf 2).isAllDay (anyOf 1)booleanAlternativeSet to true if the event lasts all day. If true, regardless of whether it's a single-day or multi-day event, start, and endtime must be set to midnight and be in the same time zone.
$ (allOf 2).isAllDay (anyOf 2)nullAlternative
$ (allOf 2).isCancelledJSONOptional
$ (allOf 2).isCancelled (anyOf 1)booleanAlternativeSet to true if the event has been canceled.
$ (allOf 2).isCancelled (anyOf 2)nullAlternative
$ (allOf 2).isDraftJSONOptional
$ (allOf 2).isDraft (anyOf 1)booleanAlternativeSet to true if the user has updated the meeting in Outlook but hasn't sent the updates to attendees. Set to false if all changes are sent, or if the event is an appointment without any attendees.
$ (allOf 2).isDraft (anyOf 2)nullAlternative
$ (allOf 2).isOnlineMeetingJSONOptional
$ (allOf 2).isOnlineMeeting (anyOf 1)booleanAlternativeTrue if this event has online meeting information (that is, onlineMeeting points to an onlineMeetingInfo resource), false otherwise. Default is false (onlineMeeting is null). Optional. After you set isOnlineMeeting to true, Microsoft Graph initializes onlineMeeting. Subsequently, Outlook ignores any further changes to isOnlineMeeting, and the meeting remains available online.
$ (allOf 2).isOnlineMeeting (anyOf 2)nullAlternative
$ (allOf 2).isOrganizerJSONOptional
$ (allOf 2).isOrganizer (anyOf 1)booleanAlternativeSet to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event). It also applies if a delegate organized the event on behalf of the owner.
$ (allOf 2).isOrganizer (anyOf 2)nullAlternative
$ (allOf 2).isReminderOnJSONOptional
$ (allOf 2).isReminderOn (anyOf 1)booleanAlternativeSet to true if an alert is set to remind the user of the event.
$ (allOf 2).isReminderOn (anyOf 2)nullAlternative
$ (allOf 2).locationJSONOptionalThe location of the event.
$ (allOf 2).location (anyOf 1)ModelAlternativeExpand Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link locations item
$ (allOf 2).location (anyOf 2)JSONAlternative
$ (allOf 2).location (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).location (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).locationsarrayOptionalThe locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection are removed and replaced by the new location value.
$ (allOf 2).locations[]ModelEach itemExpand Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link locations item
$ (allOf 2).onlineMeetingJSONOptionalDetails for an attendee to join the meeting online. The default is null. Read-only. After you set the isOnlineMeeting and onlineMeetingProvider properties to enable a meeting online, Microsoft Graph initializes onlineMeeting. When set, the meeting remains available online, and you can't change the isOnlineMeeting, onlineMeetingProvider, and onlneMeeting properties again.
$ (allOf 2).onlineMeeting (anyOf 1)ModelAlternativeExpand Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link online Meeting @odata type, conference Id, join Url, phones, quick Dial, toll Free Numbers, toll Number
$ (allOf 2).onlineMeeting (anyOf 2)JSONAlternative
$ (allOf 2).onlineMeeting (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).onlineMeeting (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).onlineMeetingProviderJSONOptionalRepresents the online meeting service provider. By default, onlineMeetingProvider is unknown. The possible values are unknown, teamsForBusiness, skypeForBusiness, and skypeForConsumer. Optional. After you set onlineMeetingProvider, Microsoft Graph initializes onlineMeeting. Subsequently, you can't change onlineMeetingProvider again, and the meeting remains available online.
$ (allOf 2).onlineMeetingProvider (anyOf 1)stringAlternativeOne of: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness
$ (allOf 2).onlineMeetingProvider (anyOf 2)JSONAlternative
$ (allOf 2).onlineMeetingProvider (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).onlineMeetingProvider (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).onlineMeetingUrlJSONOptional
$ (allOf 2).onlineMeetingUrl (anyOf 1)stringAlternativeA URL for an online meeting. The property is set only when an organizer specifies in Outlook that an event is an online meeting such as Skype. Read-only.To access the URL to join an online meeting, use joinUrl which is exposed via the onlineMeeting property of the event. The onlineMeetingUrl property will be deprecated in the future.
$ (allOf 2).onlineMeetingUrl (anyOf 2)nullAlternative
$ (allOf 2).organizerJSONOptionalThe organizer of the event.
$ (allOf 2).organizer (anyOf 1)ModelAlternativeExpand Invoke action forward — me Event events Forward — request body — body To Recipients item
$ (allOf 2).organizer (anyOf 2)JSONAlternative
$ (allOf 2).organizer (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).organizer (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).originalEndTimeZoneJSONOptional
$ (allOf 2).originalEndTimeZone (anyOf 1)stringAlternativeThe end 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.
$ (allOf 2).originalEndTimeZone (anyOf 2)nullAlternative
$ (allOf 2).originalStartJSONOptional
$ (allOf 2).originalStart (anyOf 1)stringAlternativeRepresents the start time of an event when it's initially created as an occurrence or exception in a recurring series. This property is not returned for events that are single instances. Its date and time information is expressed in ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
Format: date-time
Pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
$ (allOf 2).originalStart (anyOf 2)nullAlternative
$ (allOf 2).originalStartTimeZoneJSONOptional
$ (allOf 2).originalStartTimeZone (anyOf 1)stringAlternativeThe 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.
$ (allOf 2).originalStartTimeZone (anyOf 2)nullAlternative
$ (allOf 2).recurrenceJSONOptionalThe recurrence pattern for the event.
$ (allOf 2).recurrence (anyOf 1)ModelAlternativeExpand Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link recurrence @odata type, pattern, range
$ (allOf 2).recurrence (anyOf 2)JSONAlternative
$ (allOf 2).recurrence (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).recurrence (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).reminderMinutesBeforeStartJSONOptional
$ (allOf 2).reminderMinutesBeforeStart (anyOf 1)numberAlternativeThe number of minutes before the event start time that the reminder alert occurs.
Format: int32
Maximum: 2147483647
Minimum: -2147483648
$ (allOf 2).reminderMinutesBeforeStart (anyOf 2)nullAlternative
$ (allOf 2).responseRequestedJSONOptional
$ (allOf 2).responseRequested (anyOf 1)booleanAlternativeDefault is true, which represents the organizer would like an invitee to send a response to the event.
$ (allOf 2).responseRequested (anyOf 2)nullAlternative
$ (allOf 2).responseStatusJSONOptionalIndicates the type of response sent in response to an event message.
$ (allOf 2).responseStatus (anyOf 1)ModelAlternativeExpand Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link response Status @odata type, response, time
$ (allOf 2).responseStatus (anyOf 2)JSONAlternative
$ (allOf 2).responseStatus (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).responseStatus (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).sensitivityJSONOptionalThe possible values are: normal, personal, private, and confidential.
$ (allOf 2).sensitivity (anyOf 1)stringAlternativeOne of: normal, personal, private, confidential
$ (allOf 2).sensitivity (anyOf 2)JSONAlternative
$ (allOf 2).sensitivity (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).sensitivity (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).seriesMasterIdJSONOptional
$ (allOf 2).seriesMasterId (anyOf 1)stringAlternativeThe ID for the recurring series master item, if this event is part of a recurring series.
$ (allOf 2).seriesMasterId (anyOf 2)nullAlternative
$ (allOf 2).showAsJSONOptionalThe status to show. The possible values are: free, tentative, busy, oof, workingElsewhere, unknown.
$ (allOf 2).showAs (anyOf 1)stringAlternativeOne of: unknown, free, tentative, busy, oof, workingElsewhere
$ (allOf 2).showAs (anyOf 2)JSONAlternative
$ (allOf 2).showAs (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).showAs (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).startJSONOptionalThe start date, time, and time zone of the event. By default, the start time is in UTC.
$ (allOf 2).start (anyOf 1)ModelAlternativeExpand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time
$ (allOf 2).start (anyOf 2)JSONAlternative
$ (allOf 2).start (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).start (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).subjectJSONOptional
$ (allOf 2).subject (anyOf 1)stringAlternativeThe text of the event's subject line.
$ (allOf 2).subject (anyOf 2)nullAlternative
$ (allOf 2).transactionIdJSONOptional
$ (allOf 2).transactionId (anyOf 1)stringAlternativeA custom identifier specified by a client app for the server to avoid redundant POST operations in case of client retries to create the same event. It's useful when low network connectivity causes the client to time out before receiving a response from the server for the client's prior create-event request. After you set transactionId when creating an event, you can't change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it. Optional.
$ (allOf 2).transactionId (anyOf 2)nullAlternative
$ (allOf 2).typeJSONOptionalThe event type. The possible values are: singleInstance, occurrence, exception, seriesMaster. Read-only
$ (allOf 2).type (anyOf 1)stringAlternativeOne of: singleInstance, occurrence, exception, seriesMaster
$ (allOf 2).type (anyOf 2)JSONAlternative
$ (allOf 2).type (anyOf 2) (anyOf 1)objectAlternative
$ (allOf 2).type (anyOf 2) (anyOf 2)nullAlternative
$ (allOf 2).webLinkJSONOptional
$ (allOf 2).webLink (anyOf 1)stringAlternativeThe URL to open the event in Outlook on the web.Outlook on the web opens the event in the browser if you are signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in.This URL can't be accessed from within an iFrame.
$ (allOf 2).webLink (anyOf 2)nullAlternative

Referenced models: Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time, Get event — response body — @odata type, categories, change Key, created Date Time, id, last Modified Date Time, Invoke action forward — me Event events Forward — request body — body To Recipients item, Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link attendees item, Create message — request body — body @odata type, attachments, bcc Recipients, body, body Preview, cc Recipients, conversation Id, conversation Index, extensions, flag, from, has Attachments, importance, inference Classification, internet Message Headers, internet Message Id, is Delivery Receipt Requested, is Draft, is Read, is Read Receipt Requested, multi Value Extended Properties, parent Folder Id, received Date Time, reply To, sender, sent Date Time, single Value Extended Properties, subject, to Recipients, unique Body, web Link body @odata type, content, content Type, Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link locations item, Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link online Meeting @odata type, conference Id, join Url, phones, quick Dial, toll Free Numbers, toll Number, Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link recurrence @odata type, pattern, range, Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link response Status @odata type, response, time

Get calendar Group — response body

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get rule — response body — @odata type, id
$ (allOf 2)objectAll variants apply
$ (allOf 2).@odata.typestringOptional
$ (allOf 2).calendarsarrayOptionalThe calendars in the calendar group. Navigation property. Read-only. Nullable.
$ (allOf 2).calendars[]ModelEach itemExpand Get calendar — response body
$ (allOf 2).changeKeyJSONOptional
$ (allOf 2).changeKey (anyOf 1)stringAlternativeIdentifies the version of the calendar group. Every time the calendar group is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only.
$ (allOf 2).changeKey (anyOf 2)nullAlternative
$ (allOf 2).classIdJSONOptional
$ (allOf 2).classId (anyOf 1)stringAlternativeThe class identifier. Read-only.
Format: uuid
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
$ (allOf 2).classId (anyOf 2)nullAlternative
$ (allOf 2).nameJSONOptional
$ (allOf 2).name (anyOf 1)stringAlternativeThe group name.
$ (allOf 2).name (anyOf 2)nullAlternative

Referenced models: Get calendar — response body, Get rule — response body — @odata type, id

List calendar Groups — response body

FieldTypePresenceDescription and constraints
$objectRoot
$ (allOf 1)ModelAll variants applyExpand List rules — response body — @odata count, @odata next Link
$ (allOf 2)objectAll variants apply
$ (allOf 2).valuearrayOptional
$ (allOf 2).value[]ModelEach itemExpand Get calendar Group — response body

Referenced models: List rules — response body — @odata count, @odata next Link, Get calendar Group — response body

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.