Represent the online meeting service providers that can be used to create online meetings in this calendar.

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.

true if the user has the permission to share the calendar, false otherwise. Only the user who created the calendar can share it.

true if the user can read calendar items that have been marked private, false otherwise.

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.

Specifies the color theme to distinguish the calendar from other calendars in a UI.

The default online meeting provider for meetings sent from this calendar.

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.

true if this is the default calendar where new events are created by default, false otherwise.

Indicates whether this user calendar can be deleted from the user mailbox.

Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses.

If 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.

Calendars

true if the meeting organizer allows invitees to propose a new time when responding; otherwise, false. Optional. Default is true.

The collection of attendees for the event.

The body of the message associated with the event. It can be in HTML or text format.

The preview of the message associated with the event. It is in text format.

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.

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

The date, time, and time zone that the event ends. By default, the end time is in UTC.

The time zone that the above time is in. The value should be a Windows time zone name from the IANA time zone database. For example, "Pacific Standard Time". Required.

Set to true if the event has attachments.

When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false.

A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.

Unique identifier for the event. By default, this value changes when the item is moved from one container (such as a folder or calendar) to another. To change this behavior, use the Prefer: IdType="ImmutableId" header. See Get immutable identifiers for Outlook resources for more information. Case-sensitive and read-only.

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.

Set to true if the event has been canceled.

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.

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.

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.

Set to true if an alert is set to remind the user of the event.

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.

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.

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.

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.

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.

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

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.

The number of minutes before the event start time that the reminder alert occurs.

Default is true, which represents the organizer would like an invitee to send a response to the event.

Indicates the type of response sent in response to an event message.

Possible values are: normal, personal, private, confidential.

The ID for the recurring series master item, if this event is part of a recurring series.

The status to show. Possible values are: free, tentative, busy, oof, workingElsewhere, unknown.

The start date, time, and time zone of the event. By default, the start time is in UTC.

The date, time, and time zone that the event starts. By default, the start time is in UTC.

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.

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.

Events

MailFolders

Message Attachments

Messages

A freeform text entry field for users to describe themselves.

true if the account is enabled; otherwise, false. This property is required when a user is created.

Sets the age group of the user. Allowed values: null, Minor, NotAdult, and Adult. For more information, see legal age group property definitions.

The licenses that are assigned to the user, including inherited (group-based) licenses. This property doesn't differentiate between directly assigned and inherited licenses. Use the licenseAssignmentStates property to identify the directly assigned and inherited licenses.

The plans that are assigned to the user. Read-only. Not nullable.

Identifiers that can be used to identify and authenticate a user in non-Azure AD environments. This property can store identifiers for smartcard-based certificates that users use to access on-premises Active Directory deployments or federated access. It can also be used to store the Subject Alternate Name (SAN) that's associated with a Common Access Card (CAC). Nullable.

The birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z

The telephone numbers for the user. Only one number can be set for this property. Read-only for users synced from on-premises directory.

The city where the user is located. Maximum length is 128 characters.

Microsoft realtime communication information related to the user.

The name of the company the user is associated with. This property can be useful for describing the company that an external user comes from. The maximum length is 64 characters.

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.

The country or region where the user is located; for example, US or UK. Maximum length is 128 characters.

The date and time the user was created in ISO 8601 format and UTC. 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 Microsoft Entra ID. Property is null for some users created before June 2018 and on-premises users synced to Microsoft Entra ID before June 2018. Read-only.

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).

An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable.

The name of the department where the user works. Maximum length is 64 characters.

The name displayed in the address book for the user. This value 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.

The date and time when the user was hired or will start work if there is a future hire.

The employee identifier assigned to the user by the organization. The maximum length is 16 characters.

The date and time when the user left or will leave the organization.

Represents organization data (for example, division and costCenter) associated with a user.

Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor.

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.

Shows the timestamp for the latest change to the externalUserState property.

The given name (first name) of the user. Maximum length is 64 characters.

The hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

The unique identifier for the user. It should be treated as an opaque identifier. Inherited from directoryObject. Not nullable. Read-only.

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. It may contain multiple items with the same signInType value.

The instant message voice-over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only.

Identifies the info segments assigned to the user.

A list for users to describe their interests.

Indicates whether the user is pending an exchange mailbox license assignment. Read-only.

true if the user is a member of a restricted management administrative unit, which requires a role scoped to the restricted administrative unit to manage. Default value is false. Read-only.

The user's job title. Maximum length is 128 characters.

When this Microsoft Entra user last changed their password or when their password was created, whichever date the latest action was performed. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.

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. For more information, see legal age group property definitions.

State of license assignments for this user. It also indicates licenses that are directly assigned and the ones the user inherited through group memberships. Read-only.

The SMTP address for the user, for example, admin@contoso.com. Changes to this property also update the user's proxyAddresses collection to include the value as an SMTP address. This property can't contain accent characters.

The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters.

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. For more information, see User preferences for languages and regional formats.

The primary cellular telephone number for the user. Read-only for users synced from the on-premises directory.

The office location in the user's place of business. Maximum length is 128 characters.

Contains the on-premises Active Directory distinguished name or DN. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only.

Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only.

This property associates an on-premises Active Directory user account to their Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you're using a federated domain for the user's userPrincipalName (UPN) property. Note: The $ and _ characters can't be used when specifying this property.

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. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only.

Errors when using Microsoft synchronization product during provisioning.

Contains the on-premises sAMAccountName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only.

Contains the on-premises security identifier (SID) for the user synchronized from on-premises to the cloud. Read-only.

Contains all on-premises Session Initiation Protocol (SIP) information related to the user. Read-only.

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 Microsoft Entra ID. Read-only.

Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only.

A list of additional email addresses for the user; for example: ['bob@contoso.com', 'Robert@fabrikam.com'].

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.

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.

A list for users to enumerate their past projects.

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.

The preferred data location for the user. For more information, see OneDrive Online Multi-Geo.

The preferred language for the user. The preferred language format is based on RFC 4646. The name combines an ISO 639 two-letter lowercase culture code associated with the language and an ISO 3166 two-letter uppercase subculture code associated with the country or region. Example: 'en-US', or 'es-ES'.

The preferred name for the user. Not Supported. This attribute returns an empty string.

The plans that are provisioned for the user. Read-only. Not nullable.

For example: ['SMTP: bob@contoso.com', 'smtp: bob@sales.contoso.com']. Changes to the mail property also update this collection to include the value as an SMTP address. The proxy address prefixed with SMTP (capitalized) is the primary proxy address, while the ones prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of 10 unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable.

Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications 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 it happens, the application must acquire a new refresh token by requesting the authorized endpoint. Read-only. Use invalidateAllRefreshTokens to reset.

A list for the user to enumerate their responsibilities.

A list for the user to enumerate the schools they have attended.

Security identifier (SID) of the user, used in Windows scenarios. Read-only.

Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object.

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.

Get the last signed-in date and request ID of the sign-in for a given user. Read-only.

Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications 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 must acquire a new refresh token by requesting the authorized endpoint. Read-only. Use revokeSignInSessions to reset.

A list for the user to enumerate their skills.

The state or province in the user's address. Maximum length is 128 characters.

The street address of the user's place of business. Maximum length is 1024 characters.

The user's surname (family name or last name). Maximum length is 64 characters.

A two-letter country code (ISO standard 3166). Required for users that are assigned licenses due to legal requirements to check for availability of services in countries. Examples include: US, JP, and GB. Not nullable.

The user principal name (UPN) of the user. The UPN is an Internet-style sign-in 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 alias@domain, where the domain must be present in the tenant's verified domain collection. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization.

A String value that can be used to classify user types in your directory, such as Member and Guest.

Users

Microsoft Outlook

Cancel Event

Download Message Attachment

Retrieve the serviceUpdateMessage resources from the messages navigation property. This operation retrieves all service update messages that exist for the tenant.

List serviceAnnouncement messages

Create new navigation property to messages for admin

Retrieve the properties and relationships of a serviceUpdateMessage object. This operation retrieves a specified service update message for the tenant. The operation returns an error if the message does not exist for the tenant.

Get serviceUpdateMessage

Update the navigation property messages in admin

Delete navigation property messages for admin

Get the list of attachments associated with a service message.

List attachments

Create new navigation property to attachments for admin

Read the properties and relationships of a serviceAnnouncementAttachment object.

Get serviceAnnouncementAttachment

Update the navigation property attachments in admin

Delete navigation property attachments for admin

Update content for the navigation property attachments in admin

Delete content for the navigation property attachments in admin

Get the number of the resource

The zip file that contains all attachments for a message.

Update attachmentsArchive for the navigation property messages in admin

Delete attachmentsArchive for the navigation property messages in admin

Archive a list of serviceUpdateMessages for the signed in user.

Invoke action archive

Change the status of a list of serviceUpdateMessages to favorite for the signed in user.

Invoke action favorite

Mark a list of serviceUpdateMessages as read for the signed in user.

Invoke action markRead

Mark a list of serviceUpdateMessages as unread for the signed in user.

Invoke action markUnread

Unarchive a list of serviceUpdateMessages for the signed in user.

Invoke action unarchive

Remove the favorite status of serviceUpdateMessages for the signed in user.

Invoke action unfavorite

Retrieve the list of messages in a chat. This method supports federation. To list chat messages in application context, the request must be made from the tenant that the channel owner belongs to (represented by the tenantId property on the channel).

List messages in a chat

Send a new chatMessage in the specified chat. This API can't create a new chat; you must use the list chats method to retrieve the ID of an existing chat before you can create a chat message.

Send message in a chat

Retrieve a single message or a message reply in a channel or a chat.

Get chatMessage in a channel or chat

Update the navigation property messages in chats

Delete navigation property messages for chats

Retrieve the list of chatMessageHostedContent objects from a message. This API only lists the hosted content objects. To get the content bytes, see get chatmessage hosted content.

List hostedContents

Create new navigation property to hostedContents for chats

Retrieve the properties and relationships of chatMessageHostedContent object.

Get chatMessageHostedContent

Update the navigation property hostedContents in chats

Delete navigation property hostedContents for chats

The unique identifier for an entity. Read-only.

Update media content for the navigation property hostedContents in chats

Delete media content for the navigation property hostedContents in chats

Invoke action setReaction

Delete a single chatMessage or a chat message reply in a channel or a chat.

Invoke action softDelete

Undo soft deletion of a single chatMessage or a chat message reply in a channel or a chat.

Invoke action undoSoftDelete

Invoke action unsetReaction

Replies for a specified message. Supports $expand for channel messages.

Get replies from chats

Create new navigation property to replies for chats

Update the navigation property replies in chats

Delete navigation property replies for chats

Content in a message hosted by Microsoft Teams - for example, images or code snippets.

Get hostedContents from chats

Get media content for the navigation property hostedContents from chats

Get the list of messages from all chats in which a user is a participant, including one-on-one chats, group chats, and meeting chats. When you use delta query, you can get new or updated messages. To get the replies for a message, use the list message replies or the get message reply operations. A GET request with the delta function returns one of the following: State tokens are opaque to the client. To proceed with a round of change tracking, copy and apply the @odata.nextLink or @odata.deltaLink URL returned from the last GET request to the next delta function call. An @odata.deltaLink returned in a response signifies that the current round of change tracking is complete. You can save and use the @odata.deltaLink URL when you begin to retrieve more changes (messages changed or posted after you acquire @odata.deltaLink). For more information, see the delta query documentation.

Field Name	API Key	Type	Description
Id	id	string	The calendar's unique identifier.
Allowed Online Meeting Providers	allowedOnlineMeetingProviders	array of strings	Represent the online meeting service providers that can be used to create online meetings in this calendar.
Can Edit	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.
Can Share	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.
Can View Private Items	canViewPrivateItems	boolean	true if the user can read calendar items that have been marked private, false otherwise.

Microsoft Outlook API Integration Profile

How to work with Calendars in Microsoft Outlook API

Operations on Calendars Collection

Build every single integration your customers need with AI