Show / Hide Table of Contents

Calendars.ReadWrite

Allows the app to create, read, update, and delete events in user calendars.

Graph Methods

Type: A = Application Permission, D = Delegate Permission

Ver Type Method
V1 A,D DELETE /groups/{id}/calendar/events/{id}/
V1 A,D DELETE /groups/{id}/events/{id}
V1 A,D DELETE /me/calendar/events/{id}
V1 A,D DELETE /me/calendarGroups/{id}
V1 A,D DELETE /me/calendargroups/{id}/calendars/{id}/events/{id}
V1 A,D DELETE /me/calendars/{id}
V1 A,D DELETE /me/calendars/{id}/events/{id}
V1 A,D DELETE /me/events/{id}
V1 A,D DELETE /users/{id | userPrincipalName}/calendar/events/{id}
V1 A,D DELETE /users/{id | userPrincipalName}/calendarGroups/{id}
V1 A,D DELETE /users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}
V1 A,D DELETE /users/{id | userPrincipalName}/calendars/{id}
V1 A,D DELETE /users/{id | userPrincipalName}/calendars/{id}/events/{id}
V1 A,D DELETE /users/{id | userPrincipalName}/events/{id}
V1 A,D DELETE /users/{id}/calendar/calendarPermissions/{id}
V1 A,D GET /me/calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
V1 A,D GET /me/calendarGroups
V1 A,D GET /me/calendars
V1 A,D GET /me/events/delta
V1 A,D GET /me/events/delta?startDateTime={start_datetime}
V1 A,D GET /users/{id | userPrincipalName}/calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
V1 A,D GET /users/{id | userPrincipalName}/calendarGroups
V1 A,D GET /users/{id | userPrincipalName}/calendars
V1 A,D GET /users/{id | userPrincipalName}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
V1 A,D GET /users/{id | userPrincipalName}/events/delta
V1 A,D GET /users/{id | userPrincipalName}/events/delta?startDateTime={start_datetime}
V1 A,D GET /users/{id | userPrincipalName}/reminderView(startDateTime=startDateTime-value,endDateTime=endDateTime-value)
V1 A,D PATCH /groups/{id}/calendar/events/{id}
V1 A,D PATCH /groups/{id}/events/{id}
V1 A,D PATCH /me/calendar/events/{id}
V1 A,D PATCH /me/calendarGroups/{id}
V1 A,D PATCH /me/calendargroups/{id}/calendars/{id}/events/{id}
V1 A,D PATCH /me/calendars/{id}/events/{id}
V1 A,D PATCH /me/events/{id}
V1 A,D PATCH /users/{id | userPrincipalName}/calendar/events/{id}
V1 A,D PATCH /users/{id | userPrincipalName}/calendarGroups/{id}
V1 A,D PATCH /users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}
V1 A,D PATCH /users/{id | userPrincipalName}/calendars/{id}/events/{id}
V1 A,D PATCH /users/{id | userPrincipalName}/events/{id}
V1 A POST /bookingBusinesses/{id}/getStaffAvailability
V1 A,D POST /groups/{id}/calendar/events/{id}/cancel
V1 A,D POST /groups/{id}/events/{id}/cancel
V1 A,D POST /me/calendar/events
V1 A,D POST /me/calendar/events/{id}/accept
V1 A,D POST /me/calendar/events/{id}/attachments
V1 A,D POST /me/calendar/events/{id}/cancel
V1 A,D POST /me/calendar/events/{id}/decline
V1 A,D POST /me/calendar/events/{id}/dismissReminder
V1 A,D POST /me/calendar/events/{id}/snoozeReminder
V1 A,D POST /me/calendar/events/{id}/tentativelyAccept
V1 A,D POST /me/calendar/getSchedule
V1 A,D POST /me/calendar/getSchedule
V1 A,D POST /me/calendarGroups
V1 A,D POST /me/calendargroups/{id}/calendars/{id}/events/{id}/accept
V1 A,D POST /me/calendargroups/{id}/calendars/{id}/events/{id}/cancel
V1 A,D POST /me/calendargroups/{id}/calendars/{id}/events/{id}/decline
V1 A,D POST /me/calendargroups/{id}/calendars/{id}/events/{id}/dismissReminder
V1 A,D POST /me/calendargroups/{id}/calendars/{id}/events/{id}/snoozeReminder
V1 A,D POST /me/calendargroups/{id}/calendars/{id}/events/{id}/tentativelyAccept
V1 A,D POST /me/calendars
V1 A,D POST /me/calendars/{id}/events
V1 A,D POST /me/calendars/{id}/events/{id}/accept
V1 A,D POST /me/calendars/{id}/events/{id}/cancel
V1 A,D POST /me/calendars/{id}/events/{id}/decline
V1 A,D POST /me/calendars/{id}/events/{id}/dismissReminder
V1 A,D POST /me/calendars/{id}/events/{id}/snoozeReminder
V1 A,D POST /me/calendars/{id}/events/{id}/tentativelyAccept
V1 A,D POST /me/events
V1 A,D POST /me/events/{id}/accept
V1 A,D POST /me/events/{id}/attachments
V1 A,D POST /me/events/{id}/attachments/createUploadSession
V1 A,D POST /me/events/{id}/cancel
V1 A,D POST /me/events/{id}/decline
V1 A,D POST /me/events/{id}/dismissReminder
V1 A,D POST /me/events/{id}/snoozeReminder
V1 A,D POST /me/events/{id}/tentativelyAccept
V1 A POST /solutions/bookingBusinesses/{id}/getStaffAvailability
V1 A,D POST /users/{id | userPrincipalName}/calendar/events
V1 A,D POST /users/{id | userPrincipalName}/calendar/events/{id}/accept
V1 A,D POST /users/{id | userPrincipalName}/calendar/events/{id}/attachments
V1 A,D POST /users/{id | userPrincipalName}/calendar/events/{id}/cancel
V1 A,D POST /users/{id | userPrincipalName}/calendar/events/{id}/decline
V1 A,D POST /users/{id | userPrincipalName}/calendar/events/{id}/dismissReminder
V1 A,D POST /users/{id | userPrincipalName}/calendar/events/{id}/snoozeReminder
V1 A,D POST /users/{id | userPrincipalName}/calendar/events/{id}/tentativelyAccept
V1 A,D POST /users/{id | userPrincipalName}/calendarGroups
V1 A,D POST /users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}/accept
V1 A,D POST /users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}/cancel
V1 A,D POST /users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}/decline
V1 A,D POST /users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}/dismissReminder
V1 A,D POST /users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}/snoozeReminder
V1 A,D POST /users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events/{id}/tentativelyAccept
V1 A,D POST /users/{id | userPrincipalName}/calendars
V1 A,D POST /users/{id | userPrincipalName}/calendars/{id}/events
V1 A,D POST /users/{id | userPrincipalName}/calendars/{id}/events/{id}/accept
V1 A,D POST /users/{id | userPrincipalName}/calendars/{id}/events/{id}/cancel
V1 A,D POST /users/{id | userPrincipalName}/calendars/{id}/events/{id}/decline
V1 A,D POST /users/{id | userPrincipalName}/calendars/{id}/events/{id}/dismissReminder
V1 A,D POST /users/{id | userPrincipalName}/calendars/{id}/events/{id}/snoozeReminder
V1 A,D POST /users/{id | userPrincipalName}/calendars/{id}/events/{id}/tentativelyAccept
V1 A,D POST /users/{id | userPrincipalName}/events
V1 A,D POST /users/{id | userPrincipalName}/events/{id}/accept
V1 A,D POST /users/{id | userPrincipalName}/events/{id}/attachments
V1 A,D POST /users/{id | userPrincipalName}/events/{id}/attachments/createUploadSession
V1 A,D POST /users/{id | userPrincipalName}/events/{id}/cancel
V1 A,D POST /users/{id | userPrincipalName}/events/{id}/decline
V1 A,D POST /users/{id | userPrincipalName}/events/{id}/dismissReminder
V1 A,D POST /users/{id | userPrincipalName}/events/{id}/snoozeReminder
V1 A,D POST /users/{id | userPrincipalName}/events/{id}/tentativelyAccept
V1 A,D POST /users/{id|userPrincipalName}/calendar/getSchedule
V1 A,D Prefer: outlook.timezone="Eastern Standard Time"

Delegate Permission

Id 1ec239c2-d7c9-4623-a91a-a9775856bb36
Consent Type User
Display String Have full access to user calendars
Description Allows the app to create, read, update, and delete events in user calendars.

Application Permission

Id ef54d2bf-783f-4e0f-bca1-3210c0444d99
Display String Read and write calendars in all mailboxes
Description Allows the app to create, read, update, and delete events of all calendars without a signed-in user.

Resources

attachment

Property Type Description
contentType String The MIME type.
id String Read-only.
isInline Boolean true if the attachment is an inline attachment; otherwise, false.
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 is 2014-01-01T00:00:00Z
name String The attachment's file name.
size Int32 The length of the attachment in bytes.

attachmentItem

Property Type Description
attachmentType String The type of attachment. Possible values are: file, item, reference. Required.
contentId String The CID or Content-Id of the attachment for referencing in case of in-line attachments using <img src="cid:contentId"> tag in HTML messages. Optional.
contentType String The nature of the data in the attachment. Optional.
isInline Boolean true if the attachment is an inline attachment; otherwise, false. Optional.
name String The display name of the attachment. This can be a descriptive string and does not have to be the actual file name. Required.
size Int64 The length of the attachment in bytes. Required.

attendee

Property Type Description
emailAddress emailAddress Includes the name and SMTP address of the attendee.
proposedNewTime timeSlot An alternate date/time proposed by the attendee for a meeting request to start and end. If the attendee hasn't proposed another time, then this property is not included in a response of a GET event.
status ResponseStatus The attendee's response (none, accepted, declined, etc.) for the event and date-time that the response was sent.
type String The attendee type: required, optional, resource.

bookingAppointment

Property Type Description
additionalInformation String Additional information that is sent to the customer when an appointment is confirmed.
anonymousJoinWebUrl String The URL of the meeting to join anonymously.
customers bookingCustomerInformation collection A collection of customer properties for an appointment. An appointment will contain a list of customer information and each unit will indicate the properties of a customer who is part of that appointment. Optional.
customerTimeZone String The time zone of the customer. For a list of possible values, see dateTimeTimeZone.
duration Duration The length of the appointment, denoted in ISO8601 format.
endDateTime dateTimeTimeZone The date, time, and time zone that the appointment ends.
filledAttendeesCount Int32 The current number of customers in the appointment
id String The ID of the bookingAppointment. Read-only.
isLocationOnline Boolean If true, indicates that the appointment will be held online. Default value is false.
joinWebUrl String The URL of the online meeting for the appointment.
maximumAttendeesCount Int32 The maximum number of customers allowed in an appointment. If maximumAttendeesCount of the service is greater than 1, pass valid customer IDs while creating or updating an appointment. To create a customer, use the Create bookingCustomer operation.
optOutOfCustomerEmail Boolean If true indicates that the bookingCustomer for this appointment does not wish to receive a confirmation for this appointment.
postBuffer Duration The amount of time to reserve after the appointment ends, for cleaning up, as an example. The value is expressed in ISO8601 format.
preBuffer Duration The amount of time to reserve before the appointment begins, for preparation, as an example. The value is expressed in ISO8601 format.
price Double The regular price for an appointment for the specified bookingService.
priceType bookingPriceType A setting to provide flexibility for the pricing structure of services. Possible values are: undefined, fixedPrice, startingAt, hourly, free, priceVaries, callUs, notSet, unknownFutureValue.
reminders bookingReminder collection The collection of customer reminders sent for this appointment. The value of this property is available only when reading this bookingAppointment by its ID.
selfServiceAppointmentId String An additional tracking ID for the appointment, if the appointment has been created directly by the customer on the scheduling page, as opposed to by a staff member on the behalf of the customer. Only supported for appointment if maxAttendeeCount is 1.
serviceId String The ID of the bookingService associated with this appointment.
serviceLocation location The location where the service is delivered.
serviceName String The name of the bookingService associated with this appointment.
This property is optional when creating a new appointment. If not specified, it is computed from the service associated with the appointment by the serviceId property.
serviceNotes String Notes from a bookingStaffMember. The value of this property is available only when reading this bookingAppointment by its ID.
smsNotificationsEnabled Boolean If true, indicates SMS notifications will be sent to the customers for the appointment. Default value is false.
staffMemberIds String collection The ID of each bookingStaffMember who is scheduled in this appointment.
startDateTime dateTimeTimeZone The date, time, and time zone that the appointment begins.

bookingStaffMember

Property Type Description
availabilityIsAffectedByPersonalCalendar Boolean True means that if the staff member is a Microsoft 365 user, the Bookings API would verify the staff member's availability in their personal calendar in Microsoft 365, before making a booking.
displayName String The name of the staff member, as displayed to customers. Required.
emailAddress String The email address of the staff member. This can be in the same Microsoft 365 tenant as the business, or in a different email domain. This email address can be used if the sendConfirmationsToOwner property is set to true in the scheduling policy of the business. Required.
id String The ID of the staff member, in a GUID format. Read-only.
isEmailNotificationEnabled Boolean True indicates that a staff member will be notified via email when a booking assigned to them is created or changed.
role bookingStaffRole The role of the staff member in the business. Possible values are: guest, administrator, viewer, externalGuest, unknownFutureValue, scheduler, teamMember. Note that you must use the Prefer: include-unknown-enum-members request header to get the following values from this evolvable enum: scheduler, teamMember. Required.
timeZone String The time zone of the staff member. For a list of possible values, see dateTimeTimeZone.
useBusinessHours Boolean True means the staff member's availability is as specified in the businessHours property of the business. False means the availability is determined by the staff member's workingHours property setting.
workingHours bookingWorkHours collection The range of hours each day of the week that the staff member is available for booking. By default, they are initialized to be the same as the **b

calendar

Property Type Description
allowedOnlineMeetingProviders onlineMeetingProviderType collection Represent the online meeting service providers that can be used to create online meetings in this calendar. Possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.
canEdit Boolean true 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 has been shared a calendar and granted write access.
canShare Boolean true if the user has the permission to share the calendar, false otherwise. Only the user who created the calendar can share it.
canViewPrivateItems Boolean true if the user can read calendar items that have been marked private, false otherwise.
changeKey String Identifies 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.
color calendarColor Specifies 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.
defaultOnlineMeetingProvider onlineMeetingProviderType The default online meeting provider for meetings sent from this calendar. Possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.
hexColor String The 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.
id String The calendar's unique identifier. Read-only.
isDefaultCalendar Boolean true if this is the default calendar where new events are created by default, false otherwise.
isRemovable Boolean Indicates whether this user calendar can be deleted from the user mailbox.
isTallyingResponses Boolean Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.
name String The calendar name.
owner emailAddress If set, this represents the user who created or added the calendar. For a calendar that the user created or added, the **o

calendarGroup

Property Type Description
name String The group name.
changeKey String Identifies 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.
classId Guid The class identifier. Read-only.
id String The group's unique identifier. Read-only.

dateTimeTimeZone

Property Type Description
dateTime String A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).
timeZone String Represents a time zone, for example, "Pacific Standard Time". See below for more possible values.

event

Property Type Description
allowNewTimeProposals Boolean true if the meeting organizer allows invitees to propose a new time when responding; otherwise, false. Optional. Default is true.
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. Each category corresponds to the displayName property of an outlookCategory defined for the user.
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 is 2014-01-01T00:00:00Z
end DateTimeTimeZone The date, time, and time zone that the event ends. By default, the end time is in UTC.
hasAttachments Boolean Set to true if the event has attachments.
hideAttendees Boolean When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false.
iCalUId String A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.
id String Unique identifier for the event. !INCLUDE [outlook-beta-id] Case-sensitive and read-only.
importance String The importance of the event. The possible values are: low, normal, high.
isAllDay Boolean Set to true if the event lasts all day. If true, regardless of whether it's a single-day or multi-day event, start and end time must be set to midnight and be in the same time zone.
isCancelled Boolean Set to true if the event has been canceled.
isDraft Boolean Set to true if the user has updated the meeting in Outlook but has not sent the updates to attendees. Set to false if all changes have been sent, or if the event is an appointment without any attendees.
isOnlineMeeting Boolean True 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.
isOrganizer Boolean Set 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). This also applies if a delegate organized the event on behalf of the owner.
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 is 2014-01-01T00:00:00Z
location Location The location of the event.
locations Location collection The 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 would be removed and replaced by the new location value.
onlineMeeting OnlineMeetingInfo Details for an attendee to join the meeting online. 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 cannot change the isOnlineMeeting, onlineMeetingProvider, and onlneMeeting properties again.
onlineMeetingProvider onlineMeetingProviderType Represents 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 cannot change onlineMeetingProvider again, and the meeting remains available online.
onlineMeetingUrl String A 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.
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/Custom indicates that a legacy custom time zone was set in desktop Outlook.
originalStart DateTimeOffset Represents the start time of an event when it is 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
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 Default is true, which represents the organizer would like an invitee to send a response to the event.
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 ID for the recurring series master item, if this event is part of a recurring series.
showAs String The status to show. Possible values are: free, tentative, busy, oof, workingElsewhere, unknown.
start DateTimeTimeZone The start date, time, and time zone of the event. By default, the start time is in UTC.
subject String The text of the event's subject line.
transactionId String A 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. This is 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 cannot change transactionId in a subsequent update. This property is only returned in a response payload if an app has set it. Optional.
type String The event type. Possible values are: singleInstance, occurrence, exception, seriesMaster. Read-only
webLink String The 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 cannot be accessed from within an iFrame.

itemBody

Property Type Description
content String The content of the item.
contentType bodyType The type of the content. Possible values are text and html.

Location

Property Type Description
address physicalAddress The street address of the location.
coordinates outlookGeoCoordinates The geographic coordinates and elevation of the location.
displayName String The name associated with the location.
locationEmailAddress String Optional email address of the location.
locationUri String Optional URI representing the location.
locationType locationType The type of location. The possible values are: default, conferenceRoom, homeAddress, businessAddress,geoCoordinates, streetAddress, hotel, restaurant, localBusiness, postalAddress. Read-only.
uniqueId String For internal use only.
uniqueIdType locationUniqueIdType For internal use only.

message

Property Type Description
bccRecipients recipient collection The Bcc: recipients for the message.
body itemBody The body of the message. It can be in HTML or text format. Find out about safe HTML in a message body.
bodyPreview String The first 255 characters of the message body. It is in text format.
categories String collection The categories associated with the message.
ccRecipients recipient collection The Cc: recipients for the message.
changeKey String The version of the message.
conversationId String The ID of the conversation the email belongs to.
conversationIndex Edm.Binary Indicates the position of the message within the conversation.
createdDateTime DateTimeOffset The date and time the message was created.

The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
flag followupFlag The flag value that indicates the status, start date, due date, or completion date for the message.
from recipient The owner of the mailbox from which the message is sent. In most cases, this value is the same as the sender property, except for sharing or delegation scenarios. The value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message.
hasAttachments Boolean Indicates whether the message has attachments. This property doesn't include inline attachments, so if a message contains only inline attachments, this property is false. To verify the existence of inline attachments, parse the body property to look for a src attribute, such as <IMG src="cid:[email protected]">.
id String Unique identifier for the message. !INCLUDE [outlook-beta-id] Read-only.
importance importance The importance of the message. The possible values are: low, normal, and high.
inferenceClassification inferenceClassificationType The classification of the message for the user, based on inferred relevance or importance, or on an explicit override. The possible values are: focused or other.
internetMessageHeaders internetMessageHeader collection A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message.

Returned only on applying a $select query option. Read-only.
internetMessageId String The message ID in the format specified by RFC2822.
isDeliveryReceiptRequested Boolean Indicates whether a read receipt is requested for the message.
isDraft Boolean Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet.
isRead Boolean Indicates whether the message has been read.
isReadReceiptRequested Boolean Indicates whether a read receipt is requested for the message.
lastModifiedDateTime DateTimeOffset The date and time the message was last changed.

The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
parentFolderId String The unique identifier for the message's parent mailFolder.
receivedDateTime DateTimeOffset The date and time the message was received.

The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
replyTo recipient collection The email addresses to use when replying.
sender recipient The account that is actually used to generate the message. In most cases, this value is the same as the from property. You can set this property to a different value when sending a message from a shared mailbox, for a shared calendar, or as a delegate. In any case, the value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message.
sentDateTime DateTimeOffset The date and time the message was sent.

The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
subject String The subject of the message.
toRecipients recipient collection The To: recipients for the message.
uniqueBody itemBody The part of the body of the message that is unique to the current message. uniqueBody is not returned by default but can be retrieved for a given message by use of the ?$select=uniqueBody query. It can be in HTML or text format.
webLink String The URL to open the message in Outlook on the web.

You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, then the browser will show the message in the Outlook on the web review pane.

The message will open in the browser if you are logged in to your mailbox via Outlook on the web. You will be prompted to login if you are not already logged in with the browser.

This URL cannot be accessed from within an iFrame.

patternedRecurrence

Property Type Description
pattern recurrencePattern The frequency of an event.

For access reviews:
  • Do not specify this property for a one-time access review.
  • Only interval, dayOfMonth, and type (weekly, absoluteMonthly) properties of recurrencePattern are supported.
  • range recurrenceRange The duration of an event.

    reminder

    Property Type Description
    changeKey String Identifies the version of the reminder. Every time the reminder is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object.
    eventEndTime DateTimeTimeZone The date, time and time zone that the event ends.
    eventId String The unique ID of the event. Read only.
    eventLocation Location The location of the event.
    eventStartTime DateTimeTimeZone The date, time, and time zone that the event starts.
    eventSubject String The text of the event's subject line.
    eventWebLink String The URL to open the event in Outlook on the web.

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

    This URL cannot be accessed from within an iFrame.
    reminderFireTime DateTimeTimeZone The date, time, and time zone that the reminder is set to occur.

    scheduleInformation

    Property Type Description
    availabilityView String Represents a merged view of availability of all the items in scheduleItems. The view consists of time slots. Availability during each time slot is indicated with: 0= free, 1= tentative, 2= busy, 3= out of office, 4= working elsewhere.
    error freeBusyError Error information from attempting to get the availability of the user, distribution list, or resource.
    scheduleId String An SMTP address of the user, distribution list, or resource, identifying an instance of scheduleInformation.
    scheduleItems scheduleItem collection Contains the items that describe the availability of the user or resource.
    workingHours workingHours The days of the week and hours in a specific time zone that the user works. These are set as part of the user's mailboxSettings.

    staffAvailabilityItem

    Property Type Description
    availabilityItems availabilityItem collection Each item in this collection indicates a slot and the status of the staff member.
    staffId String The ID of the staff member.

    timeSlot

    Property Type Description
    end dateTimeTimeZone The date, time, and time zone that a period ends.
    start dateTimeTimeZone The date, time, and time zone that a period begins.

    uploadSession

    Property Type Description
    expirationDateTime DateTimeOffset The date and time in UTC that the upload session will expire. The complete file must be uploaded before this expiration time is reached.
    nextExpectedRanges String collection A collection of byte ranges that the server is missing for the file. These ranges are zero indexed and of the format "start-end" (e.g. "0-26" to indicate the first 27 bytes of the file). When uploading files as Outlook attachments, instead of a collection of ranges, this property always indicates a single value "{start}", the location in the file where the next upload should begin.
    uploadUrl String The URL endpoint that accepts PUT requests for byte ranges of the file.

    user

    Property Type Description
    aboutMe String A freeform text entry field for the user to describe themselves. Returned only on $select.
    accountEnabled Boolean true if the account is enabled; otherwise, false. This property is required when a user is created.

    Returned only on $select. Supports $filter (eq, ne, not, and in).
    ageGroup ageGroup Sets the age group of the user. Allowed values: null, Minor, NotAdult and Adult. Refer to the legal age group property definitions for further information.

    Returned only on $select. Supports $filter (eq, ne, not, and in).
    assignedLicenses assignedLicense collection The licenses that are assigned to the user, including inherited (group-based) licenses. This property doesn't differentiate directly-assigned and inherited licenses. Use the licenseAssignmentStates property to identify the directly-assigned and inherited licenses. Not nullable. Returned only on $select. Supports $filter (eq, not, /$count eq 0, /$count ne 0).
    assignedPlans assignedPlan collection The plans that are assigned to the user. Read-only. Not nullable.

    Returned only on $select. Supports $filter (eq and not).
    birthday DateTimeOffset The birthday of the user. 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 is 2014-01-01T00:00:00Z.

    Returned only on $select.
    businessPhones String collection The telephone numbers for the user. NOTE: Although this is a string collection, only one number can be set for this property. Read-only for users synced from on-premises directory.

    Returned by default. Supports $filter (eq, not, ge, le, startsWith).
    city String The city in which the user is located. Maximum length is 128 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    companyName String The company name which the user is associated. This property can be useful for describing the company that an external user comes from. The maximum length is 64 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    consentProvidedForMinor consentProvidedForMinor Sets whether consent has been obtained for minors. Allowed values: null, Granted, Denied and NotRequired. Refer to the legal age group property definitions for further information.

    Returned only on $select. Supports $filter (eq, ne, not, and in).
    country String The country/region in which the user is located; for example, US or UK. Maximum length is 128 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    createdDateTime DateTimeOffset The date and time the user was created, in ISO 8601 format and in UTC time. The value cannot be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Azure AD. Property is null for some users created before June 2018 and on-premises users that were synced to Azure AD before June 2018. Read-only. Read-only.

    Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).
    creationType String Indicates whether the user account was created through one of the following methods:
    • As a regular school or work account (null).
    • As an external account (Invitation).
    • As a local account for an Azure Active Directory B2C tenant (LocalAccount).
    • Through self-service sign-up by an internal user using email verification (EmailVerified).
    • Through self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp).

    Read-only.
    Returned only on $select. Supports $filter (eq, ne, not, in).
    deletedDateTime DateTimeOffset The date and time the user was deleted.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in).
    department String The name for the department in which the user works. Maximum length is 64 characters.

    Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, and eq on null values).
    displayName String The name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial and last name. This property is required when a user is created and it cannot be cleared during updates. Maximum length is 256 characters.

    Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values), $orderBy, and $search.
    employeeHireDate DateTimeOffset The date and time when the user was hired or will start work in case of a future hire.

    Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).
    employeeId String The employee identifier assigned to the user by the organization. The maximum length is 16 characters.

    Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
    employeeOrgData employeeOrgData Represents organization data (e.g. division and costCenter) associated with a user.

    Returned only on $select. Supports $filter (eq, ne, not , ge, le, in).
    employeeType String Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith).
    externalUserState String For an external user invited to the tenant using the invitation API, this property represents the invited user's invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users.

    Returned only on $select. Supports $filter (eq, ne, not , in).
    externalUserStateChangeDateTime DateTimeOffset Shows the timestamp for the latest change to the externalUserState property.

    Returned only on $select. Supports $filter (eq, ne, not , in).
    faxNumber String The fax number of the user.

    Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
    givenName String The given name (first name) of the user. Maximum length is 64 characters.

    Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
    hireDate DateTimeOffset The hire date of the user. 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 is 2014-01-01T00:00:00Z.

    Returned only on $select.
    Note: This property is specific to SharePoint Online. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs.
    id String The unique identifier for the user. Should be treated as an opaque identifier. Inherited from directoryObject. Key. Not nullable. Read-only.

    Returned by default. Supports $filter (eq, ne, not, in).
    identities objectIdentity collection Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft (also known as a local account), by organizations, or by social identity providers such as Facebook, Google, and Microsoft, and tied to a user account. May contain multiple items with the same signInType value.

    Returned only on $select. Supports $filter (eq) including on null values, only where the signInType is not userPrincipalName.
    imAddresses String collection The instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only.

    Returned only on $select. Supports $filter (eq, not, ge, le, startsWith).
    interests String collection A list for the user to describe their interests.

    Returned only on $select.
    isResourceAccount Boolean Do not use – reserved for future use.
    jobTitle String The user's job title. Maximum length is 128 characters.

    Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values).
    lastPasswordChangeDateTime DateTimeOffset The time when this Azure AD user last changed their password or when their password was created, whichever date the latest action was performed. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

    Returned only on $select.
    legalAgeGroupClassification legalAgeGroupClassification Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on ageGroup and consentProvidedForMinor properties. Allowed values: null, MinorWithOutParentalConsent, MinorWithParentalConsent, MinorNoParentalConsentRequired, NotAdult and Adult. Refer to the legal age group property definitions for further information.

    Returned only on $select.
    licenseAssignmentStates licenseAssignmentState collection State of license assignments for this user. Also indicates licenses that are directly-assigned and those that the user has inherited through group memberships. Read-only.

    Returned only on $select.
    mail String The SMTP address for the user, for example, [email protected]. Changes to this property will also update the user's proxyAddresses collection to include the value as an SMTP address. This property cannot contain accent characters.
    NOTE: We do not recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values).
    mailboxSettings mailboxSettings Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale and time zone.

    Returned only on $select.
    mailNickname String The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    mobilePhone String The primary cellular telephone number for the user. Read-only for users synced from on-premises directory. Maximum length is 64 characters.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    mySite String The URL for the user's personal site.

    Returned only on $select.
    officeLocation String The office location in the user's place of business.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    onPremisesDistinguishedName String Contains the on-premises Active Directory distinguished name or DN. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only.

    Returned only on $select.
    onPremisesDomainName String Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only.

    Returned only on $select.
    onPremisesExtensionAttributes onPremisesExtensionAttributes Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15.
  • For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only.
  • For a cloud-only user (where onPremisesSyncEnabled is false), these properties can be set during creation or update of a user object.
  • For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell.

  • Returned only on $select. Supports $filter (eq, ne, not, in).
    onPremisesImmutableId String This property is used to associate an on-premises Active Directory user account to their Azure AD user object. This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user's userPrincipalName (UPN) property. NOTE: The $ and _ characters cannot be used when specifying this property.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in)..
    onPremisesLastSyncDateTime DateTimeOffset Indicates the last time at which the object was synced with the on-premises directory; for example: 2013-02-16T03:04:54Z. 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 is 2014-01-01T00:00:00Z. Read-only.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in).
    onPremisesProvisioningErrors onPremisesProvisioningError collection Errors when using Microsoft synchronization product during provisioning.

    Returned only on $select. Supports $filter (eq, not, ge, le).
    onPremisesSamAccountName String Contains the on-premises samAccountName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).
    onPremisesSecurityIdentifier String Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. Read-only.

    Returned only on $select. Supports $filter (eq including on null values).
    onPremisesSyncEnabled Boolean true if this user object is currently being synced from an on-premises Active Directory (AD); otherwise the user isn't being synced and can be managed in Azure Active Directory (Azure AD). Read-only.

    Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values).
    onPremisesUserPrincipalName String Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith).
    otherMails String collection A list of additional email addresses for the user; for example: ["[email protected]", "[email protected]"].
    NOTE: This property cannot contain accent characters.

    Returned only on $select. Supports $filter (eq, not, ge, le, in, startsWith, endsWith, /$count eq 0, /$count ne 0).
    passwordPolicies String Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword.

    Returned only on $select. For more information on the default password policies, see Azure AD pasword policies. Supports $filter (ne, not, and eq on null values).
    passwordProfile passwordProfile Specifies the password profile for the user. The profile contains the user’s password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the passwordPolicies property. By default, a strong password is required.

    Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values).
    pastProjects String collection A list for the user to enumerate their past projects.

    Returned only on $select.
    postalCode String The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    preferredDataLocation String The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.
    preferredLanguage String The preferred language for the user. Should follow ISO 639-1 Code; for example en-US.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values)
    preferredName String The preferred name for the user. Not Supported. This attribute returns an empty string.

    Returned only on $select.
    provisionedPlans provisionedPlan collection The plans that are provisioned for the user. Read-only. Not nullable.

    Returned only on $select. Supports $filter (eq, not, ge, le).
    proxyAddresses String collection For example: "SMTP: [email protected]", "smtp: [email protected]"]. Changes to the mail property will also update this collection to include the value as an SMTP address. For more information, see [mail and proxyAddresses properties. The proxy address prefixed with SMTP (capitalized) is the primary proxy address while those prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of ten unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable.

    Returned only on $select. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0).
    refreshTokensValidFromDateTime DateTimeOffset Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application will need to acquire a new refresh token by making a request to the authorize endpoint.

    Returned only on $select. Read-only.
    responsibilities String collection A list for the user to enumerate their responsibilities.

    Returned only on $select.
    schools String collection A list for the user to enumerate the schools they have attended.

    Returned only on $select.
    securityIdentifier String Security identifier (SID) of the user, used in Windows scenarios.

    Read-only. Returned by default.
    Supports $select and $filter (eq, not, ge, le, startsWith).
    showInAddressList Boolean Do not use in Microsoft Graph. Manage this property through the Microsoft 365 admin center instead. Represents whether the user should be included in the Outlook global address list. See Known issue.
    signInSessionsValidFromDateTime DateTimeOffset Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application will need to acquire a new refresh token by making a request to the authorize endpoint. Read-only. Use revokeSignInSessions to reset.

    Returned only on $select.
    skills String collection A list for the user to enumerate their skills.

    Returned only on $select.
    state String The state or province in the user's address. Maximum length is 128 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    streetAddress String The street address of the user's place of business. Maximum length is 1024 characters.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    surname String The user's surname (family name or last name). Maximum length is 64 characters.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    usageLocation String A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. Examples include: US, JP, and GB. Not nullable.

    Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values).
    userPrincipalName String The user principal name (UPN) of the user. The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is [email protected], where domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization.
    NOTE: This property cannot contain accent characters. Only the following characters are allowed A - Z, a - z, 0 - 9, ' . - _ ! # ^ ~. For the complete list of allowed characters, see username policies.

    Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderBy.
    userType String A string value that can be used to classify user types in your directory, such as Member and Guest.

    Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values). **N
    In This Article
    Back to top Created by merill | Submit feedback