Skip to main content
Outlook logo
  • Category: email
  • Auth: OAUTH2, S2S_OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 331
  • Triggers: 5
  • Slug: OUTLOOK
  • Version: 20261103_00

Frequently Asked Questions

For a step-by-step guide on creating and configuring your own Microsoft (Outlook) OAuth credentials with Composio, see How to create OAuth credentials for Microsoft (Outlook).
Outlook’s webhooks send only the message ID on trigger events. To get the full message (subject, body, headers), call the OUTLOOK_GET_MESSAGE tool with that message ID.
Microsoft Graph’s send endpoint returns an HTTP 202 with no message details. To get the message ID and conversation ID, create a draft first with OUTLOOK_CREATE_DRAFT, then send it with OUTLOOK_SEND_DRAFT. See Microsoft Graph docs.
The @odata.context URL provides metadata about the response (entity set, service version, and schema info) to help clients interpret the payload structure. It’s primarily used for pagination and data parsing, not as a direct URL to the resource itself.
Microsoft/Outlook admin-consent issues are Microsoft 365 tenant-level approval problems, not something fixed by changing only the Composio connection. Adding delegated permissions to an Azure app registration is not the same as granting tenant admin consent. Once a tenant admin grants consent for the requested permissions, affected users should start a fresh normal Outlook connection flow with their own accounts; the admin does not need to connect every user individually.Two concrete ways an admin can approve are:
  1. App Registration / OAuth app level: in Microsoft Entra / Azure Portal, go to App registrations, open the OAuth app, go to API permissions, click Grant admin consent for [Tenant Name], then confirm/save.
  2. Enterprise Applications / org level: in Microsoft Entra / Azure Portal, go to Enterprise applications, find the Composio/Outlook app or the user’s own service principal, open Permissions / admin-consent controls, then grant admin consent for the organization. Microsoft Entra API permissions page showing the Grant admin consent action
Microsoft may also show an in-flow sign in as an admin / Connectez-vous avec ce compte option on the OAuth screen. Treat that as a secondary path, not the first recommendation. If an admin signs in through the same OAuth attempt, that attempt may connect the admin’s mailbox instead of the original user’s mailbox. After tenant-wide consent is granted, the original user should start a fresh Outlook connection flow with their own account.For custom Microsoft OAuth apps, a verified publisher can improve branding and may reduce consent friction in tenants that allow user consent for verified publishers and the requested delegated permissions. It does not remove the admin-consent requirement in every tenant; each Microsoft 365 tenant’s user-consent policy and the exact scopes requested still decide whether admin approval is needed.

Tools

Slug: OUTLOOK_ACCEPT_EVENTAccepts or tentatively accepts a calendar meeting invite on behalf of a user. Use this action when a user has received a meeting invitation and wants to indicate their attendance status (either confirmed or tentative). The organizer will receive a notification of the acceptance unless send_response is set to false.

Input Parameters

string
Optional text message to include with the response, sent to the organizer.
string
The user ID or userPrincipalName of the calendar owner. If not provided, uses the authenticated user (/me).
string
required
The unique identifier of the calendar event to respond to.
string ("accept" | "tentative")
Type of response: ‘accept’ to accept the invite, ‘tentative’ to tentatively accept.
boolean
Whether to send the response to the organizer. Set to false to accept without notifying.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_ADD_EVENT_ATTACHMENTAdds an attachment to a specific Outlook calendar event. Use when you need to attach a file or nested item to an existing event.

Input Parameters

object
The nested item payload; required when ‘@odata.type’ is itemAttachment.
string
required
The display name of the attachment.
string
The user’s email address or ‘me’ for the authenticated user.
string
required
The unique opaque identifier of the calendar event (NOT an email address). This is typically a long string starting with ‘AAMkA’ or ‘AQMkA’. Obtain it from listing or searching calendar events.
string ("#microsoft.graph.fileAttachment" | "#microsoft.graph.itemAttachment")
required
Attachment type: ‘#microsoft.graph.fileAttachment’ requires ‘contentBytes’; ‘#microsoft.graph.itemAttachment’ requires ‘item’.
string
MUST be base64-encoded file contents (not plain text); required when ‘@odata.type’ is fileAttachment. Raw/plain text must be base64-encoded first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_ADD_MAIL_ATTACHMENTAdds a small file attachment to an Outlook email message identified by its message ID, using an uploaded file or base64-encoded content.

Input Parameters

object
Embedded item (e.g., message, event) for itemAttachment; must include its own ‘@odata.type’.
string
Display name of the attachment (e.g., file name). Required when using content_bytes. When using the attachment field, the name is automatically inferred.
string
The user’s principal name or ‘me’ for the authenticated user.
boolean
Set to true if the attachment should appear inline in the message body.
string
Content ID for inline attachments, used in HTML body references.
object
File to attach to the email. Either provide this field OR use ‘content_bytes’. Cannot be used together with ‘content_bytes’.
string
required
Unique Microsoft Graph message ID (opaque string like ‘AAMkAGI2TAAA=’). NOT an email address - this is an internal identifier returned by Microsoft Graph API operations.
string
The OData type of the attachment. Required by Microsoft Graph API. Use ‘#microsoft.graph.fileAttachment’ for file attachments, ‘#microsoft.graph.itemAttachment’ for embedded items (messages, events, contacts).
string
MIME type of the attachment (e.g., ‘application/pdf’). Required when using content_bytes. When using the attachment field, the mimetype is automatically inferred.
string
Base64-encoded content of the file attachment (max size 3 MB). Either provide this field OR use the ‘attachment’ field (recommended). Cannot be used together with ‘attachment’.
string
URL location or path for reference attachments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_BATCH_MOVE_MESSAGESBatch-move up to 20 Outlook messages to a destination folder in a single Microsoft Graph $batch call. Use when moving multiple messages to avoid per-message move API calls.

Input Parameters

string
The UPN (User Principal Name) of the user whose messages to move, or ‘me’ for the currently authenticated user.
array
required
Array of message IDs to move. Maximum 20 items per batch (Microsoft Graph API limit). Each ID must be complete and untruncated.
string
required
The destination folder ID, or a well-known folder name (e.g., ‘inbox’, ‘deleteditems’, ‘drafts’, ‘sentitems’). If using a folder ID, it must be complete and untruncated.
string ("minimal" | "full")
Controls how much each move sub-request returns from Microsoft Graph. ‘minimal’ (default) sets Prefer: return=minimal on each sub-request, so Graph returns 204 No Content per move — the response stays small even for the maximum 20 HTML messages. In this mode moved_message_id in each result is null even on success. ‘full’ omits the Prefer header so Graph returns the full moved-message body per sub-request and moved_message_id is populated. Use ‘full’ if you need to chain follow-up calls on the new message ID; otherwise stick with ‘minimal’ to avoid multi-MB batch responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_BATCH_UPDATE_MESSAGESBatch-update up to 20 Outlook messages per call using Microsoft Graph JSON batching. Use when marking multiple messages read/unread or updating other properties to avoid per-message PATCH calls.

Input Parameters

array
required
Array of message updates to perform. Maximum 20 items per batch (Microsoft Graph API limit). For larger workloads, chunk into multiple batch calls and retry any failures.
string
The UPN (User Principal Name) of the user whose messages to update, or ‘me’ for the currently authenticated user.
string ("minimal" | "full")
Controls how much each PATCH sub-request returns from Microsoft Graph. ‘minimal’ (default) sets Prefer: return=minimal on each sub-request, so Graph returns 204 No Content per update — the response stays small even for the maximum 20 HTML messages. The action’s response shape (BatchItemResult.status / .success / .error_message) is unchanged. ‘full’ omits the Prefer header so Graph returns the full updated-message body per sub-request (status 200) — useful only if you want to inspect the raw Graph response for debugging; otherwise stick with ‘minimal’ to avoid multi-MB batch responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CALENDAR_CREATE_EVENTCreates a new Outlook calendar event, ensuring start_datetime is chronologically before end_datetime.

Input Parameters

string
The body of the event. This can be in plain text or HTML format, as specified by the ‘is_html’ field. Optional - events can be created without a body.
boolean
Specifies whether the ‘body’ content is HTML. Set to true for HTML content; otherwise, it’s treated as plain text.
string
The status to show on the calendar for the duration of the event. Valid values are: ‘free’, ‘tentative’, ‘busy’, ‘oof’ (out of office), ‘workingElsewhere’, ‘unknown’.
string
required
The subject of the calendar event.
string
The user identifier for the calendar owner. Must be either ‘me’ (for the authenticated user), a Microsoft 365 User Principal Name (e.g., user@contoso.com - must be a work/school account in the organization’s verified domain), or an Azure AD object ID (GUID). Personal email addresses (Gmail, Yahoo, Outlook.com consumer accounts, etc.) are NOT valid and will result in a 404 error.
string
The physical location of the event.
string
required
The time zone for the start and end times of the event. Uses Windows time zone names (e.g., ‘Pacific Standard Time’) or IANA time zone names (e.g., ‘America/Los_Angeles’). UTC is also a valid input.
array
A list of category names to associate with the event. The API accepts any string values. For best compatibility with Outlook UI color-coding, use category names from the user’s master category list. Category names are case-insensitive and duplicates will be automatically removed.
string
The importance of the event. Valid values are ‘low’, ‘normal’, ‘high’. Defaults to ‘normal’.
boolean
Set to true for an all-day event. When true, start_datetime and end_datetime must both be at midnight and use the same time_zone.
object
The recurrence pattern and range for an event.
string
The ID of a specific calendar to create the event in. Obtainable from the list calendars action. If omitted, the event is created on the user’s default calendar.
string
required
The event’s end date and time. Prefer local YYYY-MM-DDTHH:MM:SS with the IANA or Windows zone in time_zone. Z or a numeric offset is accepted only when it agrees with time_zone.
array
A list of attendees for the event. Accepts multiple formats: (1) Simple email strings (e.g., [‘user@example.com’]), (2) Attendee objects with ‘email’ (required), ‘name’ (optional), and ‘type’ (optional: ‘required’, ‘optional’, ‘resource’, defaults to ‘required’), (3) Microsoft Graph-style objects with nested ‘emailAddress’ containing ‘address’ and ‘name’ fields.
string
required
The event’s start date and time. Prefer local YYYY-MM-DDTHH:MM:SS with the IANA or Windows zone in time_zone. Z or a numeric offset is accepted only when it agrees with time_zone.
boolean
Set to true to indicate that the event is an online meeting. This will automatically generate an online meeting link if ‘online_meeting_provider’ is set (e.g., a Microsoft Teams link).
string
Specifies the online meeting provider. Currently, only ‘teamsForBusiness’ is supported. If ‘is_online_meeting’ is true and this is set, a meeting link for the provider will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CANCEL_CALENDAR_EVENTCancels an organizer’s event in a specified user’s calendar and sends cancellation notifications to attendees. An optional comment can accompany the cancellation.

Input Parameters

string
Optional text message sent to all attendees explaining the cancellation.
string
required
The user ID or userPrincipalName of the calendar owner. Use ‘me’ for the authenticated user.
string
required
The unique identifier of the event to cancel.
string
required
The unique identifier of the calendar containing the event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CANCEL_CALENDAR_GROUP_CALENDAR_EVENTTool to cancel an event in a user’s calendar within a calendar group and send cancellation notifications to all attendees. Use when canceling a meeting or event for a specific user in a calendar that belongs to a calendar group.

Input Parameters

string
Optional text message sent to all attendees explaining the cancellation.
string
required
The user ID or userPrincipalName of the calendar owner. Can be ‘me’ for the authenticated user or a specific user identifier.
string
required
The unique identifier of the event to cancel.
string
required
The ID of the calendar within the calendar group.
string
required
The ID of the calendar group containing the target calendar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CANCEL_EVENTCancel a calendar event for a specified user and send cancellation notifications to attendees. The calendar owner must be the meeting organizer; an optional comment can be sent with the cancellation.

Input Parameters

string
Optional text message sent to all attendees explaining the cancellation.
string
required
The user ID or userPrincipalName of the calendar owner. Use ‘me’ for the authenticated user.
string
required
The unique identifier of the calendar event to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_COPY_MAIL_FOLDERTool to copy a user’s mail folder and its contents to another folder. Use when you need to duplicate a folder structure for a specific user’s mailbox.

Input Parameters

string
required
Identifier of the user. Can be the user’s ID, userPrincipalName (email address), or ‘me’ for the authenticated user.
string
required
The folder ID or a well-known folder name where the folder should be copied to. The copied folder will be placed in this destination.
string
required
The ID of the mail folder to copy. Can be a folder ID or a well-known folder name (e.g., ‘inbox’, ‘drafts’, ‘sentitems’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_COPY_ME_MAIL_FOLDERCopies a child mail folder and its contents to a destination folder in the user’s mailbox.

Input Parameters

string
User’s id, userPrincipalName, or ‘me’ for the signed-in user.
string
required
The folder ID of the destination folder, or a well-known folder name. You can provide either the folder’s Microsoft Graph ID (e.g., ‘AAMkAGI0ZjExAAA=’) or use a well-known name like ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, etc.
string
required
The ID of the parent mail folder containing the child folder to copy.
string
required
The ID of the child folder to copy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_COPY_MESSAGETool to copy an email message to another folder within the user’s mailbox. Use when duplicating messages to multiple folders for organization.

Input Parameters

string
User’s email address, UPN, or ‘me’ for the currently authenticated user.
string
required
Unique ID of the Outlook email message to copy. Must be the complete, untruncated ID string - do not use shortened or ellipsis-containing IDs.
string
required
The destination folder ID, or a well-known folder name (e.g., ‘inbox’, ‘deleteditems’, ‘drafts’, ‘sentitems’). If using a folder ID, it must be the complete, untruncated ID string - do not use shortened or ellipsis-containing IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_COPY_MESSAGE_FROM_CHILD_FOLDERTool to copy an email message from a child folder (nested folder) to another folder within the user’s mailbox. Use when duplicating messages from nested folder structures.

Input Parameters

string
User’s email address, UPN, user object ID, or ‘me’ for the currently authenticated user.
string
required
Unique ID of the Outlook email message to copy. Must be the complete, untruncated ID string - do not use shortened or ellipsis-containing IDs.
string
required
The destination folder ID, or a well-known folder name (e.g., ‘inbox’, ‘deleteditems’, ‘drafts’, ‘sentitems’, ‘junkemail’). If using a folder ID, it must be the complete, untruncated ID string - do not use shortened or ellipsis-containing IDs.
string
required
The ID or well-known name of the parent mail folder. Common well-known names include: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. For folder IDs, obtain them from OUTLOOK_LIST_MAIL_FOLDERS. Folder IDs are base64-encoded strings (e.g., ‘AAMkAGI0ZjExAAA=’).
string
required
The ID of the child folder containing the message. Obtain this from OUTLOOK_LIST_CHILD_MAIL_FOLDERS. Child folder IDs are base64-encoded strings (e.g., ‘AAMkADAwATMwMAExAAA=’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_COPY_MESSAGE_FROM_MAIL_FOLDERTool to copy a message from a specific user’s mail folder to another folder. Use when you need to duplicate a message from a known source folder to a destination folder for a specific user.

Input Parameters

string
User’s email address, UPN, or ‘me’ for the currently authenticated user.
string
required
Unique ID of the Outlook email message to copy. Must be the complete, untruncated ID string - do not use shortened or ellipsis-containing IDs.
string
required
The destination folder ID, or a well-known folder name (e.g., ‘inbox’, ‘deleteditems’, ‘drafts’, ‘sentitems’). If using a folder ID, it must be the complete, untruncated ID string - do not use shortened or ellipsis-containing IDs.
string
required
The ID of the source mail folder containing the message. Must be the complete, untruncated ID string - do not use shortened or ellipsis-containing IDs. Can also use well-known folder names (e.g., ‘inbox’, ‘drafts’, ‘sentitems’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_COUNT_MESSAGESCount all messages, or messages matching an OData filter or KQL search, in an Outlook mailbox.

Input Parameters

string
Raw Microsoft Graph OData $filter expression applied before counting. Omit the ‘$filter=’ prefix.
Microsoft Graph message $search expression using Keyword Query Language (KQL). Omit the ‘$search=’ prefix. Cannot be combined with filter.
string
Mailbox to count messages in. Use ‘me’ for delegated authentication; for application authentication, provide the user’s ID or user principal name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_ATTACHMENT_UPLOAD_SESSIONTool to create an upload session for large (>3 MB) message attachments. Use when you need to upload attachments in chunks.

Input Parameters

string
User ID or user principal name; use ‘me’ for the signed-in user.
string
required
The unique identifier of the message to attach to.
object
required
AttachmentItem object describing the attachment in the upload session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_ATTACHMENT_UPLOAD_SESSION_IN_CHILD_FOLDERTool to create an upload session for large (>3 MB) message attachments in child mail folders. Use when you need to upload attachments to messages in nested folder structures.

Input Parameters

string
User ID or user principal name; use ‘me’ for the signed-in user.
string
required
The unique identifier of the message to attach to.
string
required
The ID or well-known name of the parent mail folder. ONLY these specific well-known names are valid as string names: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. If the folder is not one of these well-known names, you MUST use the actual folder ID - a base64-encoded string (e.g., ‘AAMkAGI0ZjExAAA=’).
object
required
AttachmentItem object describing the attachment in the upload session.
string
required
The unique identifier of the child mail folder. This is a base64-encoded string (e.g., ‘AAMkAGI0ZjExAAA=’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_CALENDARCreates a new calendar in the signed-in user’s or a specified user’s mailbox, for organizing events into a separate calendar.

Input Parameters

string
required
The display name of the new calendar.
string ("auto" | "lightBlue" | "lightGreen" | "lightOrange" | "lightGray" | "lightYellow" | "lightTeal" | "lightPink" | "lightBrown" | "lightPurple" | "lightRed")
The theme color to assign to the calendar. Supported values: auto, lightBlue, lightGreen, lightOrange, lightGray, lightYellow, lightTeal, lightPink, lightBrown, lightPurple, lightRed.
string
The UPN (User Principal Name) or object ID of the user where the calendar will be created. Use ‘me’ for the signed-in user.
string
An optional hexadecimal color code for the calendar in the format ‘#RRGGBB’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_CALENDAR_EVENTDEPRECATED: Use OUTLOOK_CREATE_USER_CALENDAR_CALENDAR_EVENT instead. Tool to create a new event in a specific Outlook calendar. Use when you need to add an event to a particular calendar by its ID.

Input Parameters

string
The body of the event. This can be in plain text or HTML format, as specified by the ‘is_html’ field. Optional - events can be created without a body.
boolean
Specifies whether the ‘body’ content is HTML. Set to true for HTML content; otherwise, it’s treated as plain text.
string
The status to show on the calendar for the duration of the event. Valid values are: ‘free’, ‘tentative’, ‘busy’, ‘oof’ (out of office), ‘workingElsewhere’, ‘unknown’.
string
required
The subject of the calendar event.
string
The user ID (GUID) or user principal name (email) of the user. Required for S2S (app-only) authentication. If not provided, defaults to the authenticated user (/me endpoint).
string
The physical location of the event.
string
required
The time zone for the start and end times of the event. Uses Windows time zone names (e.g., ‘Pacific Standard Time’) or IANA time zone names (e.g., ‘America/Los_Angeles’). UTC is also a valid input.
array
A list of category names to associate with the event. The API accepts any string values. For best compatibility with Outlook UI color-coding, use category names from the user’s master category list. Category names are case-insensitive and duplicates will be automatically removed.
string
The importance of the event. Valid values are ‘low’, ‘normal’, ‘high’. Defaults to ‘normal’.
object
The recurrence pattern and range for an event.
string
required
The ID of the calendar where the event will be created. Use calendar ID from the listCalendars action.
string
required
The event’s end date and time. Prefer local YYYY-MM-DDTHH:MM:SS with the IANA or Windows zone in time_zone. Z or a numeric offset is accepted only when it agrees with time_zone.
array
A list of attendees for the event. Accepts multiple formats: (1) Simple email strings (e.g., [‘user@example.com’]), (2) Attendee objects with ‘email’ (required), ‘name’ (optional), and ‘type’ (optional: ‘required’, ‘optional’, ‘resource’, defaults to ‘required’), (3) Microsoft Graph-style objects with nested ‘emailAddress’ containing ‘address’ and ‘name’ fields.
string
required
The event’s start date and time. Prefer local YYYY-MM-DDTHH:MM:SS with the IANA or Windows zone in time_zone. Z or a numeric offset is accepted only when it agrees with time_zone.
boolean
Set to true to indicate that the event is an online meeting. This will automatically generate an online meeting link if ‘online_meeting_provider’ is set (e.g., a Microsoft Teams link).
string
Specifies the online meeting provider. Currently, only ‘teamsForBusiness’ is supported. If ‘is_online_meeting’ is true and this is set, a meeting link for the provider will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_CALENDAR_EVENT_ATTACHMENTCreates a file or item attachment on an event in a specific calendar using the authenticated user’s mailbox. This action supports delegated access, not app-only authentication.

Input Parameters

object
The nested item payload; required when ‘@odata.type’ is itemAttachment.
string
required
The display name of the attachment.
string
required
The unique opaque identifier of the calendar event (NOT an email address). This is typically a long string starting with ‘AAMkA’ or ‘AQMkA’. Obtain it from listing or searching calendar events.
string ("#microsoft.graph.fileAttachment" | "#microsoft.graph.itemAttachment")
required
Attachment type: ‘#microsoft.graph.fileAttachment’ requires ‘contentBytes’; ‘#microsoft.graph.itemAttachment’ requires ‘item’.
string
required
The unique identifier of the calendar. This is typically a long string identifying the specific calendar.
string
MUST be base64-encoded file contents (not plain text); required when ‘@odata.type’ is fileAttachment. Raw/plain text must be base64-encoded first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_CALENDAR_EVENT_ATTACHMENT_UPLOAD_SESSIONTool to create an upload session for large calendar event attachments in a specific calendar. Use when attaching files larger than 3 MB to Outlook calendar events in a specific calendar.

Input Parameters

string
The user ID (GUID) or user principal name (email) whose calendar contains the event. Required for S2S (app-only) authentication. If not provided, uses the authenticated user context (/me endpoint).
string
required
The unique identifier of the calendar event to attach the file to. Obtain from listing or searching calendar events.
string
required
The unique identifier of the calendar containing the event. Obtain from listing calendars.
object
required
AttachmentItem object specifying the type, name, and size of the attachment to upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_CALENDAR_EVENT_IN_CALENDARTool to create a new event in a specific calendar for a user. Use when you need to create events in a specific calendar (e.g., shared or secondary calendars).

Input Parameters

object
required
The end date, time, and time zone of the event.
object
The body content of an event.
object
required
The start date, time, and time zone of the event.
string
required
The subject/title of the event.
string
required
The user identifier for the calendar owner. Must be either ‘me’ (for the authenticated user), a Microsoft 365 User Principal Name (e.g., user@contoso.com), or an Azure AD object ID (GUID).
object
Location information for an event.
array
A list of attendees for the event. Optional - events can be created without attendees.
object
The recurrence pattern and range for an event.
string
required
The unique identifier of the calendar where the event will be created. This allows creating events in specific calendars (e.g., shared calendars, secondary calendars).
boolean
True to indicate that the event is an online meeting. This will automatically generate an online meeting link if onlineMeetingProvider is set.
string
The online meeting provider. Currently, only ‘teamsForBusiness’ is supported.
boolean
True if the meeting organizer allows invitees to propose a new time when responding. Default is true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_CALENDAR_GROUPTool to create a new calendar group for a user. Use when needing to organize calendars into groups.

Input Parameters

string
required
The name of the calendar group.
string
required
The user’s principal name (UPN) or object ID. Must be an actual user ID (not ‘me’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_CALENDAR_GROUP_CALENDAR_EVENT_ATTACHMENTTool to create a new attachment for an event in a calendar within a calendar group for a specific user. Use when you need to attach a file or item to an event in a user’s calendar group.

Input Parameters

object
The nested item payload; required when ‘@odata.type’ is itemAttachment.
string
required
The display name of the attachment.
string
The unique identifier of the user. Can use ‘me’ as shortcut for authenticated user.
string
required
The unique opaque identifier of the calendar event (NOT an email address). This is typically a long string starting with ‘AAMkA’ or ‘AQMkA’. Obtain it from listing or searching calendar events.
string ("#microsoft.graph.fileAttachment" | "#microsoft.graph.itemAttachment")
required
Attachment type: ‘#microsoft.graph.fileAttachment’ requires ‘contentBytes’; ‘#microsoft.graph.itemAttachment’ requires ‘item’.
string
required
The unique identifier of the calendar within the calendar group.
string
MUST be base64-encoded file contents (not plain text); required when ‘@odata.type’ is fileAttachment. Raw/plain text must be base64-encoded first.
string
required
The unique identifier of the calendar group containing the target calendar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_CALENDAR_GROUP_CALENDAR_EVENT_EXTENSIONTool to create a new open extension on a calendar event within a specific calendar group and calendar. Use when you need to store custom data with an event.

Input Parameters

string
The unique identifier of the user. Can use ‘me’ as shortcut for authenticated user.
string
required
The unique identifier of the calendar event to add the extension to.
string
required
The unique identifier of the calendar within the calendar group.
string
required
The unique name for the extension. Must follow the format ‘Com.Company.ExtensionName’ (e.g., Com.Contoso.EventTest).
string
required
The unique identifier of the calendar group.
object
Custom properties to store in the extension as key-value pairs. Each property can be a string, number, or boolean value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_CALENDAR_PERMISSIONTool to create a calendar permission for a specific calendar in a calendar group. Use when granting access to a calendar for another user.

Input Parameters

string ("none" | "freeBusyRead" | "limitedRead" | "read" | "write" | "delegateWithoutPrivateEventAccess" | "delegateWithPrivateEventAccess" | "custom")
required
The permission role to grant. Options: none (no access), freeBusyRead (view availability only), limitedRead (view availability and titles), read (view all event details), write (view and edit events), delegateWithoutPrivateEventAccess (delegate access excluding private events), delegateWithPrivateEventAccess (full delegate access including private events), custom (custom permissions).
string
User ID or userPrincipalName. Use ‘me’ for the signed-in user.
string
required
The ID of the calendar to which the permission will be added.
boolean
True if the permission can be removed by the user, false otherwise. Optional.
object
required
Email address object containing the name and address of the person receiving the permission.
string
required
The ID of the calendar group containing the calendar.
boolean
True if the user is inside the same organization as the calendar owner, false otherwise. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_CAL_GROUP_EVENT_ATTACH_UPLOADTool to create an upload session for large calendar group event attachments. Use when attaching files larger than 3 MB to events in calendar groups.

Input Parameters

string
required
The user ID or user principal name. Use ‘me’ for the authenticated user.
string
required
The unique identifier of the calendar event to attach the file to. Obtain from listing or searching calendar events.
string
required
The unique identifier of the calendar within the calendar group. Obtain from listing calendars in the group.
object
required
AttachmentItem object specifying the type, name, and size of the attachment to upload.
string
required
The unique identifier of the calendar group. Obtain from listing calendar groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_CONTACTCreates a new contact in a Microsoft Outlook user’s contacts folder.

Input Parameters

string
Personal notes about the contact. These notes are stored as ‘personalNotes’ in the Outlook contact details.
string
Identifier for the user whose contact list will be modified. Use ‘me’ for the authenticated user (recommended), or provide the user’s object ID (GUID) or userPrincipalName (UPN). The UPN is typically in email format (e.g., ‘user@contoso.com’) and must match an existing user in your Azure AD tenant.
string
The contact’s surname (last name).
string
The contact’s birthday in ‘YYYY-MM-DD’ format. The time component will be set to midnight UTC (e.g., ‘1990-01-01’ becomes ‘1990-01-01T00:00:00Z’ in the API request).
string
The contact’s job title.
string
The contact’s given (first) name.
string
The contact’s home phone number. If provided, this will be stored in Outlook as a list containing this single number.
array
A list of categories to assign to the contact.
string
The department the contact belongs to within their company.
string
The name of the company the contact is associated with.
string
The contact’s display name, typically their full name.
string
The contact’s mobile phone number.
array
A list of business phone numbers for the contact. Each number should be a string.
array
A list of email addresses for the contact. Each item must be an object with an address field (string) and optionally a name field (e.g., [{'address': 'jane@example.com', 'name': 'Jane Doe'}]). Plain strings are not accepted.
string
The contact’s office location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_CONTACT_FOLDERTool to create a new contact folder in the user’s mailbox. Use when needing to organize contacts into custom folders.

Input Parameters

string
The user’s principal name or object ID. Use ‘me’ for the authenticated user.
string
required
The display name of the new contact folder.
string
The ID of the parent contact folder. If omitted, created under the default contacts folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_CONTACT_FOLDER_CHILD_FOLDERTool to create a child contact folder within a parent contact folder for a specific user. Use when you need to organize contacts into nested folder hierarchies for a given user.

Input Parameters

string
required
The unique identifier of the user. Can use ‘me’ as a shortcut for the authenticated user, or provide user ID or userPrincipalName.
string
required
The display name of the new child contact folder.
string
required
The ID of the parent contact folder under which to create the child folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_DRAFTCreates a new Outlook email draft with subject, body, recipients, and an optional attachment. This action creates a standalone draft for new conversations. To create a draft reply to an existing conversation/message, use the OUTLOOK_CREATE_DRAFT_REPLY action instead.

Input Parameters

string
required
Content of the email draft; use is_html to specify if HTML or plain text.
boolean
Specifies if the body is HTML. If False, body is plain text. Set to True when body contains HTML markup; otherwise markup renders as literal text.
string
required
Subject line for the email draft.
string
User ID (GUID) or user principal name (email) for S2S (app-only) authentication. Required when using application permissions. If not provided, defaults to ‘/me’ endpoint for delegated authentication.
string
Optional file(s) to attach. Accepts a single file or a list of files.
array
Optional list of CC (carbon copy) recipient email addresses. Must be provided as an array of strings, e.g., [“cc@example.com”].
array
Optional list of primary ‘To’ recipient email addresses. Must be provided as an array of strings, e.g., [“user@example.com”] for a single recipient or [“user1@example.com”, “user2@example.com”] for multiple recipients. Do not pass as a JSON-encoded string. Can be omitted when creating a draft to be completed later. To send the draft, at least one valid address must be present across to_recipients, cc_recipients, or bcc_recipients.
array
Optional list of BCC (blind carbon copy) recipient email addresses. Must be provided as an array of strings, e.g., [“bcc@example.com”].

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_DRAFT_REPLYCreates a draft reply in the specified user’s Outlook mailbox to an existing message (identified by a valid message_id), optionally including a comment and CC/BCC recipients.

Input Parameters

string
Plain text comment to include in the body of the reply draft.
string
User’s mailbox identifier (email or ‘me’) for the original message and new draft location.
array
List of email addresses to add as CC recipients to the draft reply.
array
List of email addresses to add as BCC recipients to the draft reply.
string
required
Required. Unique ID of the message to reply to. Obtain this from actions like ‘List Messages’, ‘Get Message’, or ‘Search Messages’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_EMAIL_RULECreate email rule filter with conditions and actions

Input Parameters

object
required
Actions to take when the rule conditions are met.
string
User ID or principal name for app-only (S2S) authentication. Required for application permissions. Use the user’s GUID or email address (e.g., ‘43f0c14d-bca8-421f-b762-c3d8dd75be1f’ or ‘user@domain.com’).
integer
Order in which the rule is executed (lower numbers execute first, minimum value is 1).
object
required
Conditions that must be met for the rule to apply.
boolean
Whether the rule is enabled.
string
required
Display name for the email rule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_EVENT_ATTACHMENTTool to create a new attachment for a user’s calendar event. Use when you need to attach a file or item to an existing event in a specific user’s calendar.

Input Parameters

object
The nested item payload; required when ‘@odata.type’ is ‘#microsoft.graph.itemAttachment’.
string
required
The display name of the attachment.
string
required
The user’s email address or user ID. Use ‘me’ for the authenticated user or provide the user’s email address.
string
required
The unique opaque identifier of the calendar event. This is typically a long string starting with ‘AAMkA’ or ‘AQMkA’. Obtain it from listing or searching calendar events.
string ("#microsoft.graph.fileAttachment" | "#microsoft.graph.itemAttachment")
required
Attachment type: ‘#microsoft.graph.fileAttachment’ requires ‘contentBytes’; ‘#microsoft.graph.itemAttachment’ requires ‘item’.
string
MUST be base64-encoded file contents (not plain text); required when ‘@odata.type’ is ‘#microsoft.graph.fileAttachment’. Raw/plain text must be base64-encoded first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_EVENT_ATTACHMENT_UPLOAD_SESSIONTool to create an upload session for large calendar event attachments. Use when attaching files larger than 3 MB to Outlook calendar events.

Input Parameters

string
User ID or user principal name; use ‘me’ for the authenticated user.
string
required
The unique identifier of the calendar event to attach the file to. Obtain from listing or searching calendar events.
object
required
AttachmentItem object specifying the type, name, and size of the attachment to upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_FORWARD_DRAFTTool to create a forward draft of an Outlook message for a specific user. Use when you need to prepare a forward email that can be edited before sending. The draft is created in the Drafts folder with the FW: prefix in the subject line.

Input Parameters

string
Optional comment to include in the body of the forward draft. This text appears before the original message content.
string
User’s email address, UPN, or ‘me’ for the currently authenticated user. Use ‘me’ to access your own mailbox or specify another user’s email address.
string
required
The unique identifier of the message to create a forward draft for. This is a base64-encoded string typically starting with ‘AAMk’ or ‘AQMk’. Obtain this from list messages, get message, or search messages actions. Do NOT use email addresses or conversation IDs.
array
Optional list of email addresses to set as recipients for the forward draft. Recipients can be added or modified later by updating the draft before sending.
string
required
The ID or well-known name of the mail folder containing the message. Valid well-known names: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. For other folders, use the base64-encoded folder ID obtained from list mail folders actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_GROUP_EVENTCreate an event in a Microsoft 365 group’s default calendar using delegated access. Supplying attendees sends meeting invitations to them.

Input Parameters

object
required
End date, time, and time zone of the event.
object
Text or HTML event body.
object
required
Start date, time, and time zone of the event.
string
required
Subject of the event.
string
required
Opaque ID of the Microsoft 365 group that owns the calendar.
object
Event location.
array
Required, optional, or resource attendees. Supplying attendees sends meeting invitations to them.
boolean
Whether Microsoft Graph should create an online meeting.
string ("unknown" | "teamsForBusiness" | "skypeForBusiness" | "skypeForConsumer")
Online meeting provider to use. The group’s calendar must list the selected provider in allowedOnlineMeetingProviders.
boolean
Whether attendees may propose a new meeting time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_MAIL_FOLDERTool to create a new mail folder. Use when you need to organize email into a new folder.

Input Parameters

string
Identifier for the user whose mailbox the folder will be created in. Use ‘me’ for the authenticated user or provide the user’s principal name or ID.
boolean
Indicates whether the new folder is hidden. Default is false. Once set, this property cannot be updated.
string
required
The display name of the new mail folder.
boolean
If true and a folder with the same name already exists, return the existing folder instead of raising an error. This makes the operation idempotent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_MAIL_FOLDER_MESSAGETool to create a new message in a specific mail folder. Use when you need to create a draft message in a particular folder (e.g., drafts, custom folders).

Input Parameters

object
Message body content with content type.
string
The subject line of the message.
string
User’s id, userPrincipalName, or ‘me’ for the signed-in user.
string
required
The ID or well-known name of the mail folder where the message will be created. ONLY these specific well-known names are valid as string names: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. If the folder is not one of these well-known names, you MUST use the actual folder ID - a base64-encoded string (e.g., ‘AAMkAGI0ZjExAAA=’) obtained from OUTLOOK_LIST_MAIL_FOLDERS or OUTLOOK_LIST_CHILD_MAIL_FOLDERS.
array
The Cc: recipients for the message.
array
The To: recipients for the message.
array
The Bcc: recipients for the message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_MAIL_FOLDER_MESSAGE_ATTACHMENTTool to add an attachment to a message in a specific mail folder. Use when you need to attach a file to a message located in a particular mail folder.

Input Parameters

object
Embedded item (e.g., message, event) for itemAttachment; must include its own ‘@odata.type’.
string
Display name of the attachment (e.g., file name). Required when using content_bytes. When using the attachment field, the name is automatically inferred.
string
The user ID or user principal name (email) to access mailbox data for. Required for app-only (S2S) authentication. For delegated auth, uses /me endpoint. Can be a GUID (e.g., ‘43f0c14d-bca8-421f-b762-c3d8dd75be1f’) or email (e.g., ‘user@domain.com’).
boolean
Set to true if the attachment should appear inline in the message body.
string
Content ID for inline attachments, used in HTML body references.
object
File to attach to the email. Either provide this field OR use ‘content_bytes’. Cannot be used together with ‘content_bytes’.
string
required
Unique Microsoft Graph message ID (opaque string like ‘AAMkAGI2TAAA=’). NOT an email address - this is an internal identifier returned by Microsoft Graph API operations.
string
The OData type of the attachment. Required by Microsoft Graph API. Use ‘#microsoft.graph.fileAttachment’ for file attachments, ‘#microsoft.graph.itemAttachment’ for embedded items (messages, events, contacts).
string
MIME type of the attachment (e.g., ‘application/pdf’). Required when using content_bytes. When using the attachment field, the mimetype is automatically inferred.
string
Base64-encoded content of the file attachment (max size 3 MB). Either provide this field OR use the ‘attachment’ field (recommended). Cannot be used together with ‘attachment’.
string
required
The ID or well-known name of the mail folder containing the message. ONLY these specific well-known names are valid as string names: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. Arbitrary folder names are NOT valid. If the folder is not one of these well-known names, you MUST use the actual folder ID - a base64-encoded string (e.g., ‘AAMkAGI0ZjExAAA=’) obtained from list mail folders operations.
string
URL location or path for reference attachments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_MAIL_FOLDER_MESSAGE_ATTACHMENT_UPLOAD_SESSIONTool to create an upload session for large (>3 MB) message attachments in a specific mail folder. Use when you need to upload attachments in chunks to a message located in a mail folder.

Input Parameters

string
User ID or user principal name; use ‘me’ for the signed-in user.
string
required
The unique identifier of the message to attach to.
string
required
The unique identifier of the mail folder containing the message.
object
required
AttachmentItem object describing the attachment in the upload session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_MAIL_FOLDER_MESSAGE_RULETool to create a message rule in a user’s mail folder. Use when automating message processing with filters and actions.

Input Parameters

object
required
Actions to take when the rule conditions are met.
string
The unique identifier of the user. Can use ‘me’ shortcut for /me/ path or actual user ID for /users/{user_id}/ path.
integer
required
Order in which the rule is executed (lower numbers execute first, minimum value is 1).
object
Conditions that trigger the rule actions.
object
Conditions that trigger the rule actions.
boolean
Whether the rule is enabled.
string
required
Display name for the message rule.
string
required
The ID of the mail folder where the message rule will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_MASTER_CATEGORYDEPRECATED: Use OUTLOOK_CREATE_USER_MASTER_CATEGORY instead. Tool to create a new category in the user’s master category list. Use after selecting a unique display name.

Input Parameters

string ("preset0" | "preset1" | "preset2" | "preset3" | "preset4" | "preset5" | "preset6" | "preset7" | "preset8" | "preset9" | "preset10" | "preset11" | "preset12" | "preset13" | "preset14" | "preset15" | "preset16" | "preset17" | "preset18" | "preset19" | "preset20" | "preset21" | "preset22" | "preset23" | "preset24")
A pre-set color constant for the category. Allowed values: preset0 through preset24.
string
The user ID (GUID or email) for which to create the master category. Required for S2S (Service-to-Service) authentication. If not provided, uses /me endpoint (requires delegated authentication).
string
required
Unique name that identifies the category in the user’s mailbox. Verify uniqueness by checking all paginated pages of OUTLOOK_GET_MASTER_CATEGORIES before creation; duplicate displayName will cause creation failure.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_ME_CALENDAR_EVENT_EXTENSIONTool to create a new open extension on a calendar event for a specific user. Use when you need to store custom data with an event.

Input Parameters

string
The user identifier for the calendar owner. Must be either ‘me’ (for the authenticated user), a Microsoft 365 User Principal Name (e.g., user@contoso.com), or an Azure AD object ID (GUID).
string
required
The unique identifier of the calendar event to add the extension to.
string
required
The unique identifier of the calendar containing the event.
string
required
The unique name for the extension. Must follow the format ‘Com.Company.ExtensionName’ (e.g., Com.Contoso.TestExtension).
object
Custom properties to store in the extension as key-value pairs. Each property can be a string, number, or boolean value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_ME_CALENDAR_PERMISSIONTool to create a new calendar permission for a specific user’s calendar. Use when you need to share another user’s calendar with someone or grant access with specific permission levels.

Input Parameters

string ("freeBusyRead" | "limitedRead" | "read" | "write")
required
The permission role to grant. freeBusyRead: view free/busy status only. limitedRead: view free/busy status, titles and locations. read: view all details except private events. write: view all details except private events and edit events.
string
required
The unique identifier of the user whose calendar permissions will be modified. Cannot use ‘me’ shortcut - must be actual user ID or userPrincipalName.
string
required
The unique identifier of the calendar to which permissions will be added.
boolean
Whether the permission can be removed in the future. If set to true, the recipient can later be removed from the calendar permissions. Optional parameter.
object
required
Email address information (name and address) of the person or entity to grant calendar permission to.
boolean
Whether the recipient is inside the same organization as the calendar owner. Optional parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_ME_CHILD_FOLDER_MESSAGETool to create a new draft message in a child folder within a user’s mail folder. Use when creating messages in nested folder structures for a specific user’s mailbox.

Input Parameters

object
The body of the message.
string
The subject of the message.
string
required
Identifier of the user. Can be the user’s ID, userPrincipalName (email address), or ‘me’ for the authenticated user.
array
A list of categories to assign to the message.
string
The importance of the message. Possible values are ‘low’, ‘normal’, or ‘high’.
array
The Cc: recipients for the message.
array
The To: recipients for the message.
array
The Bcc: recipients for the message.
string
required
Identifier of the parent mail folder. Must be a valid mail folder ID.
string
required
Identifier of the child folder where the message will be created. Must be a valid child folder ID within the specified parent mail folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_ME_CONTACT_FOLDERS_CONTACTSTool to create a new contact in a specific user’s contact folder. Use when you need to add a contact to a particular folder for a specified user.

Input Parameters

string
Personal notes about the contact. These notes are stored as ‘personalNotes’ in the Outlook contact details.
string
required
The unique identifier of the user whose contact folder will be modified. Can be the user’s object ID (GUID) or userPrincipalName (e.g., ‘user@contoso.com’).
string
The contact’s surname (last name).
string
The contact’s birthday in ‘YYYY-MM-DD’ format. The time component will be set to midnight UTC (e.g., ‘1990-01-01’ becomes ‘1990-01-01T00:00:00Z’ in the API request).
string
The contact’s job title.
string
The contact’s given (first) name.
string
The contact’s home phone number. If provided, this will be stored in Outlook as a list containing this single number.
array
A list of categories to assign to the contact.
string
The department the contact belongs to within their company.
string
The name of the company the contact is associated with.
string
The contact’s display name, typically their full name.
string
The contact’s mobile phone number.
array
A list of business phone numbers for the contact. Each number should be a string.
array
A list of email addresses for the contact.
string
The contact’s office location.
string
required
Identifier of the contact folder where the new contact will be created. Must be a valid contact folder ID obtained from ‘Get Contact Folders’ or ‘List Contact Folders’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_ME_CONTACT_FOLDERS_CONTACTS_EXTENSIONSTool to create a new open extension on a contact within a user’s contact folder. Use when you need to store custom data with a contact.

Input Parameters

string
required
The unique identifier of the user. Can be the user’s object ID (GUID) or userPrincipalName (e.g., ‘user@contoso.com’).
string
required
The unique identifier of the contact to add the extension to.
string
required
The unique name for the extension. Must follow reverse DNS format (e.g., com.contoso.extensionName).
string
required
The unique identifier of the contact folder containing the contact.
object
Custom properties to store in the extension as key-value pairs. Each property can be a string, number, or boolean value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_ME_CONTACT_FOLDERS_EXTENSIONSTool to create a new open extension on a contact within a child folder. Use when you need to store custom data with a contact.

Input Parameters

string
The unique identifier or user principal name (UPN) of the user. Required for S2S (app-only) authentication. If not provided, uses /me/ endpoint for delegated authentication.
string
required
The unique identifier of the contact to add the extension to.
string
required
The unique name for the extension. Must follow reverse DNS format (e.g., com.contoso.extensionName).
string
required
The unique identifier of the child folder within the contact folder.
string
required
The unique identifier of the contact folder.
object
Custom properties to store in the extension as key-value pairs. Each property can be a string, number, or boolean value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_ME_CONTACT_IN_CHILD_FOLDERTool to create a new contact in a child folder within a contact folder. Use when you need to add a contact to a specific nested folder structure.

Input Parameters

string
Personal notes about the contact. These notes are stored as ‘personalNotes’ in the Outlook contact details.
string
The contact’s surname (last name).
string
The user’s principal name or object ID. Use ‘me’ for the authenticated user.
string
The contact’s birthday in ‘YYYY-MM-DD’ format. The time component will be set to midnight UTC (e.g., ‘1990-01-01’ becomes ‘1990-01-01T00:00:00Z’ in the API request).
string
The contact’s job title.
string
The contact’s given (first) name.
string
The contact’s home phone number. If provided, this will be stored in Outlook as a list containing this single number.
array
A list of categories to assign to the contact.
string
The department the contact belongs to within their company.
string
The name of the company the contact is associated with.
string
The contact’s display name, typically their full name.
string
The contact’s mobile phone number.
array
A list of business phone numbers for the contact. Each number should be a string.
array
A list of email addresses for the contact.
string
The contact’s office location.
string
required
Identifier of the child folder within the contact folder where the new contact will be created.
string
required
Identifier of the parent contact folder. Must be a valid contact folder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_ME_EVENTCreate a new calendar event in a user’s default calendar.

Input Parameters

object
required
The end date, time, and time zone of the event.
object
The body content of an event.
object
required
The start date, time, and time zone of the event.
string
required
The subject/title of the event.
string
The user identifier for the calendar owner. Must be either ‘me’ (for the authenticated user), a Microsoft 365 User Principal Name (e.g., user@contoso.com), or an Azure AD object ID (GUID).
object
Location information for an event.
array
A list of attendees for the event. Optional - events can be created without attendees.
boolean
True to indicate that the event is an online meeting. This will automatically generate an online meeting link if onlineMeetingProvider is set.
string
The online meeting provider. Currently, only ‘teamsForBusiness’ is supported.
boolean
True if the meeting organizer allows invitees to propose a new time when responding. Default is true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_ME_EVENT_ATTACHMENT_UPLOAD_SESSIONTool to create an upload session for large event attachments. Use when attaching files larger than 3 MB to the authenticated user’s Outlook events.

Input Parameters

string
The user ID (GUID) or user principal name (email) to create the upload session for. Required for S2S (app-only) authentication. If not provided, uses the authenticated user context (/me endpoint).
string
required
The unique identifier of the event to attach the file to. Obtain from listing or searching events.
object
required
AttachmentItem object specifying the type, name, and size of the attachment to upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_ME_FORWARD_DRAFTTool to create a draft forward of an existing message. Use when you need to prepare a forward that can be edited before sending. The draft can be updated with recipients and additional content before being sent.

Input Parameters

string
Optional comment to include in the body of the forward draft.
string
User’s mailbox identifier (email or ‘me’) for the original message and new draft location.
string
required
Required. Unique ID of the message to forward. Obtain this from actions like ‘List Messages’, ‘Get Message’, or ‘Search Messages’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_ME_INFERENCE_CLASSIFICATION_OVERRIDETool to create a Focused Inbox override for a sender identified by SMTP address for a specific user. Use when you need to configure messages from a specific sender to always be classified as focused or other for a particular user.

Input Parameters

string
required
The unique identifier of the user. Can be user ID (GUID) or user principal name (UPN).
string ("focused" | "other")
required
How messages from the specified sender should always be classified. Must be either ‘focused’ or ‘other’.
object
required
Email address information for the sender to create the override for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_ME_MAIL_FOLDER_MESSAGE_REPLY_ALL_DRAFTCreates a reply-all draft for a message in a specified mail folder, optionally including a comment. This tool is deprecated.

Input Parameters

string
Optional plain text comment to include in the body of the reply-all draft.
string
The user ID or principal name (email) of the user to create a reply-all draft for. Required for app-only (S2S) authentication. Use either the GUID format (e.g., ‘43f0c14d-bca8-421f-b762-c3d8dd75be1f’) or email format (e.g., ‘user@domain.com’). If not provided, defaults to ‘/me’ endpoint for delegated authentication.
string
required
The unique identifier of the message to create a reply-all draft for. This is a base64-encoded string typically starting with ‘AAMk’ or ‘AQMk’. Obtain this from list messages, get message, or search messages actions. Do NOT use email addresses or conversation IDs.
string
required
The ID or well-known name of the mail folder containing the message. Valid well-known names: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. For other folders, use the base64-encoded folder ID obtained from list mail folders actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_ME_MESSAGE_REPLY_ALL_DRAFTTool to create a draft reply-all to a user’s message. Use when you need to create a draft reply to the sender and all recipients of an email message in a user’s mailbox.

Input Parameters

string
Optional plain text comment to include in the body of the reply-all draft.
string
required
User’s email address, user principal name (UPN), or ‘me’ for the currently authenticated user. Use ‘me’ to access your own mailbox or specify another user’s email address.
string
required
The unique identifier of the message to create a reply-all draft for. This is a base64-encoded string typically starting with ‘AAMk’ or ‘AQMk’. Obtain this from list messages, get message, or search messages actions. Do NOT use email addresses or conversation IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_ME_REPLY_ALL_DRAFTTool to create a draft reply-all to a message in a child folder. Use when you need to create a draft reply to the sender and all recipients of a message located in a subfolder within a mail folder.

Input Parameters

string
Optional plain text comment to include in the body of the reply-all draft.
string
User’s email address, UPN, or ‘me’ for the currently authenticated user. Use ‘me’ to access your own mailbox or specify another user’s email address.
string
required
The unique identifier of the message to create a reply-all draft for. This is a base64-encoded string typically starting with ‘AAMk’ or ‘AQMk’. Obtain this from list messages, get message, or search messages actions. Do NOT use email addresses or conversation IDs.
string
required
The ID or well-known name of the parent mail folder. Valid well-known names: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. For other folders, use the base64-encoded folder ID obtained from list mail folders actions.
string
required
The ID of the child folder (subfolder) within the parent mail folder. This is a base64-encoded folder ID obtained from list mail folders actions. Child folders are nested folders within a parent folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_ME_REPLY_DRAFTDeprecated. Creates a reply draft for a specified message in the authenticated user’s or another user’s mailbox.

Input Parameters

string
User’s mailbox identifier. Use ‘me’ for the authenticated user or provide a specific user ID.
string
required
The unique identifier of the message to create a reply draft for. Must be a non-draft message. Typically a base64-encoded string obtained from list messages or search messages actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_MESSAGE_ATTACHMENTTool to create an attachment for a message. Use when you need to attach a file or item to an existing message. Supports file attachments, item attachments, and reference attachments.

Input Parameters

object
Generic payload for item attachments. Accepts any additional fields.
string
required
The display name of the attachment.
string
User ID or userPrincipalName. Use ‘me’ for the authenticated user. For S2S connections, pass the specific user ID.
boolean
Set to true if the attachment should appear inline in the message body.
string
Content ID for inline attachments, used in HTML body references.
string
required
The unique identifier of the message to add the attachment to.
string ("#microsoft.graph.fileAttachment" | "#microsoft.graph.itemAttachment" | "#microsoft.graph.referenceAttachment")
required
Type of attachment to create. Use ‘#microsoft.graph.fileAttachment’ for files, ‘#microsoft.graph.itemAttachment’ for embedded items, or ‘#microsoft.graph.referenceAttachment’ for references.
string
The MIME type of the attachment (e.g., ‘text/plain’, ‘application/pdf’).
string
Base64-encoded file contents. Required when ‘@odata.type’ is fileAttachment. Must be valid base64.
string
The ID or well-known name of the parent mail folder. Common well-known names include: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, etc. For custom folders, use the actual folder ID. Optional - if not provided, the message will be accessed directly by ID.
string
The ID of the child mail folder containing the message. This must be a base64-encoded folder ID. Only used when mail_folder_id is specified. Well-known names are NOT valid for child folders.
string
URL location or path for reference attachments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_REPLY_ALL_DRAFTTool to create a reply-all draft for a message in a mail folder. Use when you need to create a draft reply to all recipients of an email.

Input Parameters

string
Plain text comment to include in the body of the reply-all draft.
string
User’s mailbox identifier (email or ‘me’) for the original message and new draft location.
string
required
Required. Unique ID of the message to reply to. Obtain this from actions like ‘List Messages’, ‘Get Message’, or ‘Search Messages’.
string
required
Required. The unique identifier of the mail folder containing the message to reply to. Obtain this from actions like ‘List Mail Folders’ or ‘Get Mail Folder’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_TASKTool to create a new task in Microsoft To Do within a specified task list. Use when adding tasks with title, due dates, reminders, importance levels, descriptions, categories, and linked resources.

Input Parameters

object
Task body content with content type.
string
required
The title of the task. This is the main text displayed for the task.
string
User ID or userPrincipalName. Use ‘me’ for the signed-in user (delegated auth) or a specific user ID for app-only (S2S) authentication.
array
A list of category labels to organize the task (e.g., tags for filtering or grouping tasks).
string
The importance level of the task. Must be one of: ‘low’, ‘normal’, or ‘high’. Defaults to ‘normal’ if not specified.
object
Date/time with timezone information for task due dates and reminders.
array
A list of resources (documents, links, emails) associated with the task. Each resource can have a webUrl, applicationName, and displayName.
object
Date/time with timezone information for task due dates and reminders.
string
required
The unique identifier of the task list where the task will be created. Use the List To Do task lists action to retrieve available list IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_USER_CALENDAR_EVENT_ATTACHMENTTool to create a new attachment for an event in a specific user’s calendar. Use when you need to attach a file or item to an event within a particular user’s calendar.

Input Parameters

object
The nested item payload; required when ‘@odata.type’ is itemAttachment.
string
required
The display name of the attachment.
string
required
The user’s ID or userPrincipalName (email address). This identifies the user whose calendar contains the event.
string
required
The unique opaque identifier of the calendar event (NOT an email address). This is typically a long string starting with ‘AAMkA’ or ‘AQMkA’. Obtain it from listing or searching calendar events.
string ("#microsoft.graph.fileAttachment" | "#microsoft.graph.itemAttachment")
required
Attachment type: ‘#microsoft.graph.fileAttachment’ requires ‘contentBytes’; ‘#microsoft.graph.itemAttachment’ requires ‘item’.
string
required
The unique identifier of the calendar containing the event. This is typically a long opaque string identifying the specific calendar.
string
MUST be base64-encoded file contents (not plain text); required when ‘@odata.type’ is fileAttachment. Raw/plain text must be base64-encoded first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_USER_CALENDAR_GROUP_CALENDARTool to create a new calendar in a calendar group for a specific user. Use when organizing events into a separate calendar within a specific calendar group for a user.

Input Parameters

string
required
The display name of the new calendar.
string ("auto" | "lightBlue" | "lightGreen" | "lightOrange" | "lightGray" | "lightYellow" | "lightTeal" | "lightPink" | "lightBrown" | "lightPurple" | "lightRed")
The theme color to assign to the calendar. Supported values: auto, lightBlue, lightGreen, lightOrange, lightGray, lightYellow, lightTeal, lightPink, lightBrown, lightPurple, lightRed.
string
The unique identifier for the user (can also be userPrincipalName). Use ‘me’ for the authenticated user.
string
required
The unique identifier for the calendar group where the calendar will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_USER_CALENDAR_GROUP_EVENTTool to create a new calendar event in a specific user’s calendar within a calendar group. Use when creating events for a particular user in a calendar that belongs to a calendar group.

Input Parameters

object
required
The end date, time, and time zone of the event.
object
The body content of the event.
object
required
The start date, time, and time zone of the event.
string
The status to show on the calendar. Valid values: ‘free’, ‘tentative’, ‘busy’, ‘oof’, ‘workingElsewhere’, ‘unknown’.
string
required
The subject/title of the event.
string
required
The user ID or user principal name (UPN) of the target user. Note: ‘me’ is not supported for this endpoint - you must provide an actual email address or user ID.
object
The location of an event.
array
List of attendees for the event.
array
A list of category names to associate with the event.
string
The importance of the event. Valid values: ‘low’, ‘normal’, ‘high’.
string
required
The ID of the calendar within the calendar group where the event will be created.
string
required
The ID of the calendar group containing the target calendar.
boolean
Set to true to indicate that the event is an online meeting.
string
The online meeting provider. Currently only ‘teamsForBusiness’ is supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_USER_CONTACTS_EXTENSIONSTool to create a new open extension on a specific user’s contact. Use when you need to store custom data with a contact for a specific user.

Input Parameters

string
required
The unique identifier of the user. Can be the user’s object ID (GUID) or userPrincipalName (e.g., ‘user@contoso.com’).
string
required
The unique identifier of the contact to add the extension to.
string
required
The unique name for the extension. Must follow reverse DNS format (e.g., Com.Contoso.ExtensionName).
object
Custom properties to store in the extension as key-value pairs. Each property can be a string, number, or boolean value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_USER_EVENT_ATTACHMENT_UPLOAD_SESSIONCreates an upload session for a file attachment on a specified user’s calendar event and returns the upload URL and session details. This tool is deprecated.

Input Parameters

string
required
User ID or user principal name. Use the unique identifier or email address of the user whose event you want to add an attachment to.
string
required
The unique identifier of the calendar event to attach the file to. Obtain from listing or searching calendar events.
object
required
AttachmentItem object specifying the type, name, and size of the attachment to upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_USER_EVENT_CALENDAR_PERMISSIONTool to create a calendar permission via an event’s calendar. Use when granting calendar access through an event by specifying the event ID and user email address.

Input Parameters

string ("read" | "write" | "freeBusyRead" | "limitedRead")
required
The permission role to grant. Options: read (view all event details), write (view and edit events), freeBusyRead (view availability only), limitedRead (view availability and titles).
string
The user ID or principal name of the user. Use ‘me’ for the authenticated user.
string
required
The unique identifier of the event whose calendar will have the permission added.
boolean
True if the permission can be removed by the user, false otherwise. Optional.
object
required
Email address object containing the name and address of the person receiving the permission.
boolean
True if the user is inside the same organization as the calendar owner, false otherwise. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_USER_MAIL_CHILD_FOLDER_MSG_EXTTool to create a new open extension on a message in a child mail folder for any user. Use when you need to store custom data with a message in a nested folder structure.

Input Parameters

string
User ID or userPrincipalName. Use ‘me’ for the authenticated user.
string
required
The unique identifier of the message to add the extension to.
string
required
The unique name for the extension. Must follow the format ‘Com.Company.ExtensionName’ (e.g., Com.Contoso.TestExtension).
string
required
The unique identifier of the parent mail folder.
string
required
The unique identifier of the child folder containing the message.
object
Custom properties to store in the extension as key-value pairs. Each property can be a string, number, or boolean value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_USER_MAIL_FOLDER_MESSAGE_EXTENSIONTool to create a new open extension on a message in a user’s mail folder. Use when you need to store custom data with a specific message in a user’s mailbox.

Input Parameters

string
required
The unique identifier of the user. Can be the user’s object ID (GUID) or userPrincipalName (e.g., ‘user@contoso.com’).
string
required
The unique identifier of the message to add the extension to.
string
required
The unique name for the extension. Must follow the format ‘Com.Company.ExtensionName’ (e.g., Com.Contoso.Test).
string
required
The unique identifier of the mail folder containing the message.
object
Custom properties to store in the extension as key-value pairs. Each property can be a string, number, or boolean value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_USER_MAIL_FOLDER_MESSAGE_REPLY_DRAFTTool to create a reply draft for a message in a user’s mail folder. Use when you need to prepare a reply without sending it immediately. The draft is created in the Drafts folder and includes the RE: prefix in the subject line.

Input Parameters

string
Optional plain text comment to include in the body of the reply draft.
string
required
The unique identifier of the user. Use ‘me’ for the authenticated user, or provide a specific user principal name (email address) or user ID.
string
required
The unique identifier of the message to reply to. This is a base64-encoded string typically starting with ‘AAMk’ or ‘AQMk’. Obtain this from list messages, get message, or search messages actions. Do NOT use email addresses or conversation IDs.
string
required
The ID or well-known name of the mail folder containing the message. Valid well-known names: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. For other folders, use the base64-encoded folder ID obtained from list mail folders actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_USER_MAIL_FOLDERS_CHILD_FOLDERSTool to create a new child folder under a specified mail folder for a user. Use when organizing email into nested folder hierarchies within a specific user’s mailbox.

Input Parameters

string
required
User’s ID or userPrincipalName. The unique identifier of the user whose mailbox will contain the new child folder. Use ‘me’ for the signed-in user with delegated authentication; application authentication requires an explicit user ID or userPrincipalName.
boolean
Indicates whether the new child folder should be hidden. Default is false. Once set during creation, this property cannot be updated later.
string
required
The display name of the new child folder. This is the name that will be visible to the user in their mail client.
string
required
The ID or well-known name of the parent mail folder under which to create the child folder. Common well-known names include: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. For folder IDs, obtain them from listing mail folders - they are base64-encoded strings (e.g., ‘AQMkADAwATMwMAExLTlmNjktOWVmYS0wMAItMDAKAC4AAAPLkCuWz0mbS4RvWyTvc1LKAQDGTYrvat2PSKIu8IS9hMqyAAACAQwAAAA=’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_USER_MASTER_CATEGORYTool to create a new category in a user’s master category list. Use when you need to add a category to organize email and calendar items for a specific user.

Input Parameters

string ("preset0" | "preset1" | "preset2" | "preset3" | "preset4" | "preset5" | "preset6" | "preset7" | "preset8" | "preset9" | "preset10" | "preset11" | "preset12" | "preset13" | "preset14" | "preset15" | "preset16" | "preset17" | "preset18" | "preset19" | "preset20" | "preset21" | "preset22" | "preset23" | "preset24")
A pre-set color constant for the category. Allowed values: preset0 through preset24.
string
The user’s unique identifier or principal name. Use ‘me’ for the signed-in user.
string
required
Unique name that identifies the category in the user’s mailbox.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_USER_MESSAGETool to create a new draft message in a user’s mailbox. Use when creating draft messages for a specific user or the authenticated user.

Input Parameters

object
The body of the message.
object
Represents a message recipient.
object
Represents a message recipient.
string
The subject of the message.
string
The user’s ID, userPrincipalName (email address), or ‘me’ to represent the authenticated user. Creates the message in the specified user’s mailbox.
array
A list of categories to assign to the message.
string ("low" | "normal" | "high")
Message importance levels.
array
The Cc: recipients for the message.
array
The To: recipients for the message.
array
The Bcc: recipients for the message.
array
Custom message headers to add to the message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_CREATE_USER_MESSAGE_ATTACHMENTTool to create an attachment on a message in a user’s mail folder. Use when you need to attach a file or item to an existing message in a specific user’s mailbox.

Input Parameters

object
The nested item payload (message, event, or contact) with its own ‘@odata.type’. Required when ‘@odata.type’ is ‘#microsoft.graph.itemAttachment’.
string
required
The display name of the attachment (e.g., file name like ‘document.pdf’ or ‘image.png’).
string
required
The unique identifier of the user. Can be the user’s UPN (user principal name) or the user’s object ID.
boolean
Set to true if the attachment should appear inline within the message body content.
string
Content ID for inline attachments, used to reference the attachment within the HTML message body.
string
required
The unique identifier of the message to attach to. This is NOT an email address but an opaque string identifier returned by Microsoft Graph API operations.
string ("#microsoft.graph.fileAttachment" | "#microsoft.graph.itemAttachment" | "#microsoft.graph.referenceAttachment")
required
The OData type of the attachment. Use ‘#microsoft.graph.fileAttachment’ for file attachments (requires ‘contentBytes’), ‘#microsoft.graph.itemAttachment’ for embedded items like messages or events (requires ‘item’), or ‘#microsoft.graph.referenceAttachment’ for reference attachments (requires link and permission details).
string
The MIME type of the attachment (e.g., ‘text/plain’, ‘application/pdf’). Optional but recommended for file attachments.
string
Base64-encoded content of the file attachment. Required when ‘@odata.type’ is ‘#microsoft.graph.fileAttachment’. Must be valid base64-encoded data.
string
required
The unique identifier of the mail folder containing the message. This is typically a long opaque string identifying the specific folder.
string
URI indicating the content location of the attachment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DECLINE_EVENTDeclines a calendar event invitation, optionally including a comment or proposed new time and controlling whether a response is sent. Returns a success message when the request is accepted.

Input Parameters

string
Optional text message to include in the response to the event organizer explaining the decline.
string
The user’s primary SMTP address, user principal name (UPN), or the alias ‘me’ (for the signed-in user) to identify the calendar owner.
string
required
The unique identifier of the calendar event to decline.
boolean
If true, a decline response is sent to the organizer; if false, no response is sent. Default is true.
object
A time period with start and end times.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CALENDARTool to delete a calendar other than the default calendar from a user’s mailbox. Use when removing calendars that are no longer needed.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the signed-in user.
string
required
Unique identifier of the calendar to delete. Cannot be the default calendar. This ID can be obtained from List Calendars action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CALENDAR_EVENTTool to delete a calendar event from a user’s Outlook calendar. Use when removing events that are no longer needed or were created in error.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the signed-in user.
string
required
The unique identifier of the calendar event to delete. This ID can be obtained from List Events or Get Event actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CALENDAR_EVENT_ATTACHMENTTool to delete an attachment from an event in a specific user’s calendar. Use when you need to remove a file or item attachment from an event in a calendar.

Input Parameters

string
The unique identifier of the user. Can use ‘me’ as shortcut for authenticated user.
string
required
The unique identifier of the calendar event containing the attachment to delete.
string
required
The unique identifier of the calendar containing the event. Can be obtained from listing calendars.
string
required
The unique identifier of the attachment to delete. Can be obtained from listing event attachments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CALENDAR_EVENT_FROM_SPECIFIC_CALENDARTool to delete an event from a specific calendar in Outlook. Use when removing events from secondary or shared calendars by providing both calendar ID and event ID.

Input Parameters

string
The user ID or email address to delete the event for. Required for S2S (Service-to-Service) authentication. If not provided, defaults to /me endpoint for delegated authentication.
string
required
The unique identifier of the event to delete from the specified calendar. This ID can be obtained from List Events or Get Event actions.
string
required
The unique identifier of the calendar containing the event. This ID can be obtained from List Calendars action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CALENDAR_FROM_GROUPTool to delete a calendar from a specific user’s calendar group in Microsoft Outlook. Use when removing a calendar that belongs to a user’s calendar group.

Input Parameters

string
required
The unique identifier of the user whose calendar group calendar to delete. Can be the user’s email address or user ID.
string
required
The unique identifier of the calendar to delete. Note: Default calendars with isRemovable: false cannot be deleted.
string
required
The unique identifier of the calendar group containing the calendar to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CALENDAR_GROUPTool to delete a calendar group other than the default calendar group. Use when removing unused calendar groups from the mailbox.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the signed-in user.
string
required
Unique identifier of the calendar group to delete. Cannot be used to delete the default calendar group. This ID can be obtained from List Calendar Groups action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CALENDAR_GROUP_CALENDAR_EVENTTool to delete a calendar event from a specific user’s calendar within a calendar group. Use when removing events from calendars organized under calendar groups for a specific user.

Input Parameters

string
required
The unique identifier of the user. Must be an actual user ID, not ‘me’ shortcut.
string
required
The unique identifier of the calendar event to delete. This ID can be obtained from List Events or Get Event actions.
string
required
The unique identifier of the calendar within the calendar group.
string
required
The unique identifier of the calendar group containing the target calendar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CALENDAR_GROUP_EVENT_ATTACHMENTTool to delete an attachment from an event in a calendar within a calendar group. Use when you need to remove a file or item attachment from an event in a specific calendar group.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the authenticated user (delegated auth) or specify a user ID/email for S2S (app-only) authentication.
string
required
The unique identifier of the calendar event containing the attachment to delete.
string
required
The unique identifier of the calendar within the calendar group.
string
required
The unique identifier of the attachment to delete. Can be obtained from listing event attachments.
string
required
The unique identifier of the calendar group containing the target calendar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CALENDAR_GROUP_EVENT_PERMANENTLYTool to permanently delete a calendar event from a calendar within a calendar group. Use when you need to ensure an event cannot be restored from deleted items.

Input Parameters

string
The unique identifier (GUID) or user principal name (email) of the user. Required for app-only (S2S) authentication. If not provided, defaults to /me endpoint for delegated authentication.
string
required
The unique identifier of the calendar event to permanently delete. The event will be permanently deleted and cannot be recovered by the user.
string
required
The unique identifier of the calendar within the calendar group.
string
required
The unique identifier of the calendar group containing the target calendar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CALENDAR_PERMANENTLYPermanently deletes a calendar from a user’s mailbox. Unlike standard DELETE, this action makes the calendar permanently unrecoverable. Use when you need to ensure a calendar cannot be restored from deleted items.

Input Parameters

string
User’s email address, UPN, or ‘me’ for the currently authenticated user.
string
required
Unique identifier of the calendar to permanently delete. The calendar will be permanently deleted and cannot be recovered by the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CALENDAR_PERMISSIONTool to delete a calendar permission from a user’s calendar within a calendar group. Use when revoking calendar sharing access for specific users.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the signed-in user.
string
required
The unique identifier of the calendar within the group.
string
required
The unique identifier of the calendar permission to delete. This ID can be obtained from listing calendar permissions.
string
required
The unique identifier of the calendar group containing the calendar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CHILD_CONTACT_FOLDER_PERMANENTLYPermanently deletes a child contact folder. Unlike standard DELETE, this action makes the folder permanently unrecoverable. Use when you need to ensure a child contact folder cannot be restored from deleted items.

Input Parameters

string
User’s email address, UPN, or ‘me’ for the currently authenticated user.
string
required
Unique identifier of the child contact folder to permanently delete. The folder will be permanently deleted and cannot be recovered by the user.
string
required
Unique identifier of the parent contact folder containing the child folder to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CHILD_FOLDER_MESSAGETool to delete a message from a child mail folder in Outlook. Use when removing messages from nested folder structures or cleaning up messages in subfolders.

Input Parameters

string
The UPN (User Principal Name) or ID of the user; use ‘me’ for the signed-in user.
string
required
The unique identifier of the message to delete from the child folder. Typically a base64-encoded string obtained from list messages or search messages actions.
string
required
The ID or well-known name of the parent mail folder. Common well-known names include: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’. For folder IDs, use base64-encoded strings (e.g., ‘AAMkAGI0ZjExAAA=’) obtained from list mail folders actions.
string
required
The ID of the child folder containing the message to delete. Must be a base64-encoded folder ID (e.g., ‘AAMkADAwATMwMAExAAA=’) obtained from list child folders actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CONTACTPermanently deletes an existing contact, using its contact_id (obtainable via ‘List User Contacts’ or ‘Get Contact’), from the Outlook contacts of the user specified by user_id.

Input Parameters

string
The UPN (User Principal Name) or ID of the user; use ‘me’ for the signed-in user.
string
required
Identifier of the contact to be deleted, typically obtained from ‘List User Contacts’ or ‘Get Contact’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CONTACT_FOLDERTool to delete a contact folder from the user’s mailbox. Use when you need to remove an existing contact folder.

Input Parameters

string
The UPN (User Principal Name) or ID of the user; use ‘me’ for the signed-in user.
string
required
Identifier of the contact folder to be deleted. Must be a valid contact folder ID obtained from ‘Get Contact Folders’ or ‘Create Contact Folder’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CONTACT_FOLDER_CHILD_FOLDERTool to delete a child contact folder from a parent contact folder for a specific user. Use when removing nested contact folders from a user’s mailbox.

Input Parameters

string
The UPN (User Principal Name) or ID of the user; use ‘me’ for the signed-in user.
string
required
The unique identifier of the child contact folder to delete. This ID can be obtained from Get Contact Folders action.
string
required
The unique identifier of the parent contact folder. This ID can be obtained from Get Contact Folders action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CONTACT_FOLDER_CONTACTTool to permanently delete a contact from a specific contact folder. Use when removing contacts from organized folders in Outlook.

Input Parameters

string
The UPN (User Principal Name) or ID of the user; use ‘me’ for the signed-in user.
string
required
Unique identifier of the contact to delete from the folder, typically obtained from ‘List User Contacts’ or ‘Get Contact’.
string
required
Unique identifier of the contact folder containing the contact to delete, typically obtained from ‘Get Contact Folders’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CONTACT_FOLDER_PERMANENTLYPermanently deletes a contact folder. Unlike standard DELETE, this action makes the folder permanently unrecoverable. Use when you need to ensure a contact folder cannot be restored from deleted items.

Input Parameters

string
User’s email address, UPN, or ‘me’ for the currently authenticated user.
string
required
Unique identifier of the contact folder to permanently delete. The folder will be permanently deleted and cannot be recovered by the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CONTACT_FROM_CHILD_FOLDER_PERMANENTLYTool to permanently delete a contact from a child folder for a specific user. Use when you need to ensure a contact cannot be restored from deleted items.

Input Parameters

string
required
The unique identifier of the user. Can be the user’s email address (UPN) or their Azure AD object ID.
string
required
Identifier of the contact to be permanently deleted. The contact will be permanently deleted and cannot be recovered. Must be obtained from ‘List Contacts’ or ‘Get Contact’.
string
required
Identifier of the child folder within the parent contact folder containing the contact to permanently delete. Must be a valid child folder ID.
string
required
Identifier of the parent contact folder. Must be a valid contact folder ID obtained from ‘Get Contact Folders’ or ‘List Contact Folders’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CONTACT_FROM_FOLDER_PERMANENTLYPermanently deletes a contact from a specific contact folder. Unlike standard DELETE, this action makes the contact permanently unrecoverable. Use when you need to ensure a contact in a folder cannot be restored from deleted items.

Input Parameters

string
User’s email address, UPN, or ‘me’ for the currently authenticated user.
string
required
Unique identifier of the contact to permanently delete. The contact will be permanently deleted and cannot be recovered by the user.
string
required
Unique identifier of the contact folder containing the contact to permanently delete. Must be a valid contact folder ID obtained from list or get contact folders actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CONTACT_PERMANENTLYPermanently deletes a contact. Unlike standard DELETE, this action makes the contact permanently unrecoverable. Use when you need to ensure a contact cannot be restored from deleted items.

Input Parameters

string
User’s email address, UPN, or ‘me’ for the currently authenticated user.
string
required
Unique identifier of the contact to permanently delete. The contact will be permanently deleted and cannot be recovered by the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_CONTACTS_EXTENSIONSTool to delete a navigation property extension from a contact within a child folder. Use when removing custom extension data from a contact.

Input Parameters

string
The unique identifier of the user. Can be the user’s object ID (GUID) or userPrincipalName (e.g., ‘user@contoso.com’). If not provided, uses the authenticated user context (/me endpoint).
string
required
The unique identifier of the contact that has the extension to delete.
string
required
The unique identifier of the extension to delete. Can be the full extension ID (e.g., Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.TestExtension) or just the extension name (e.g., Com.Contoso.TestExtension).
string
required
The unique identifier of the child folder within the contact folder.
string
required
The unique identifier of the contact folder containing the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_EMAIL_RULEDelete an email rule permanently; deletion is irreversible. Confirm rule details with the user before executing. Removing a rule may alter the firing order and stop-processing behavior of remaining rules.

Input Parameters

string
required
ID of the email rule to delete.
string
The unique identifier of the user. Can use ‘me’ shortcut for /me/ path or actual user ID for /users/{user_id}/ path. Required for S2S (app-only) authentication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_EVENTDEPRECATED: Use OUTLOOK_DELETE_CALENDAR_EVENT instead. Tool to delete an event from the user’s calendar. Use when removing calendar events. If this is a meeting, deleting it removes it from the organizer’s calendar and sends a cancellation message to all attendees. Require explicit user confirmation before calling this action.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the authenticated user or a specific user ID for S2S (app-only) authentication.
string
required
The unique identifier of the event to delete. This ID can be obtained from list events or get event actions. For recurring events, verify whether this ID is the series master (deletes entire series) or a specific instance (deletes one occurrence). Obtain from OUTLOOK_LIST_EVENTS, OUTLOOK_GET_EVENT, or OUTLOOK_GET_CALENDAR_VIEW.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_EVENT_ATTACHMENTTool to delete an attachment from an Outlook calendar event. Use when you need to remove a file or item attachment from an existing event.

Input Parameters

string
The user’s email address or ‘me’ for the authenticated user.
string
required
The unique identifier of the calendar event containing the attachment to delete.
string
required
The unique identifier of the attachment to delete. Can be obtained from listing event attachments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_EVENT_EXTENSIONTool to delete an open extension from a calendar event in a calendar group. Use when removing custom extension data that is no longer needed.

Input Parameters

string
The user ID (GUID) or user principal name (email) of the target user. Required for S2S (app-only) authentication. If not provided, defaults to ‘/me’ for delegated authentication.
string
required
The unique identifier of the calendar event containing the extension to delete.
string
required
The unique identifier of the calendar within the calendar group.
string
required
The unique identifier of the extension to delete. Can be the full extension ID (e.g., Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.TestExtension) or just the extension name (e.g., Com.Contoso.TestExtension).
string
required
The unique identifier of the calendar group containing the calendar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_EVENT_PERMANENTLYPermanently deletes a calendar event. Unlike standard DELETE, this action makes the event permanently unrecoverable. Use when you need to ensure an event cannot be restored from deleted items.

Input Parameters

string
User’s email address, UPN, or ‘me’ for the currently authenticated user.
string
required
Unique identifier of the calendar event to permanently delete. The event will be permanently deleted and cannot be recovered by the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_MAIL_FOLDERDelete a mail folder from a user’s mailbox. The tool rejects well-known system folder names as folder identifiers.

Input Parameters

string
Identifier for the user whose mailbox contains the folder to delete. Use ‘me’ for the authenticated user or provide the user’s principal name or ID.
string
required
The Microsoft Graph folder ID (a base64-encoded string like ‘AAMkAGI0ZjExAAA=’) of the custom mail folder to delete. IMPORTANT: You can ONLY delete custom folders you created. System folders (Inbox, Drafts, SentItems, DeletedItems, JunkEmail, Outbox, Archive, etc.) are ‘distinguished folders’ and CANNOT be deleted - attempting to do so will result in an error. Use the ‘List mail folders’ action to find the ID of a custom folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_MAIL_FOLDER_MESSAGETool to delete a message from a specific mail folder in Outlook. Use when removing messages from a particular folder or cleaning up folder contents.

Input Parameters

string
The UPN (User Principal Name) or ID of the user; use ‘me’ for the signed-in user.
string
required
The unique identifier of the message to delete from the mail folder. Typically a base64-encoded string obtained from list messages or search messages actions.
string
required
The ID or well-known name of the mail folder containing the message. Common well-known names include: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’. For folder IDs, use base64-encoded strings (e.g., ‘AAMkAGI0ZjExAAA=’) obtained from list mail folders actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_MASTER_CATEGORYTool to delete a category from the user’s master category list. Use when removing unused or obsolete categories from the mailbox.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the signed-in user.
string
required
Unique identifier of the Outlook category to delete. This ID can be obtained from Get Master Categories action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_ME_CALENDAR_PERMISSIONTool to delete a calendar permission from a specific user’s calendar. Use when revoking access to a shared calendar.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the signed-in user.
string
required
The unique identifier of the calendar. This ID can be obtained from List Calendars action.
string
required
The unique identifier of the calendar permission to delete. This ID can be obtained from listing calendar permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_ME_CONTACT_EXTENSIONTool to delete an open extension from a contact. Use when removing custom data extensions that are no longer needed.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the authenticated user.
string
required
Unique identifier of the contact from which to delete the extension.
string
required
The extension identifier. Can be the extension name or fully qualified name (e.g., ‘Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.TestExtension’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_ME_CONTACT_FOLDER_CONTACT_EXTENSIONTool to delete an extension from a contact in a user’s contact folder. Use when removing custom extension data from a contact.

Input Parameters

string
The UPN (User Principal Name) or ID of the user; use ‘me’ for the signed-in user.
string
required
The unique identifier of the contact that has the extension to delete.
string
required
The unique identifier of the extension to delete. Can be the full extension ID (e.g., Microsoft.OutlookServices.OpenTypeExtension.com.contoso.roamingSettings) or just the extension name (e.g., com.contoso.roamingSettings).
string
required
The unique identifier of the contact folder containing the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_ME_EVENT_EXTENSIONTool to delete an open extension from a user’s calendar event. Use when removing custom extension data that is no longer needed.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the signed-in user.
string
required
The unique identifier of the calendar event containing the extension to delete.
string
required
The unique identifier of the extension to delete. Can be the full extension ID (e.g., Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.Referral) or just the extension name (e.g., Com.Contoso.Referral).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_ME_EVENTS_ATTACHMENTSTool to delete an attachment from a user’s Outlook event. Use when you need to remove a file or item attachment from an existing event.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the authenticated user.
string
required
The unique identifier of the event containing the attachment to delete.
string
required
The unique identifier of the attachment to delete. Can be obtained from listing event attachments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_ME_INFERENCE_CLASSIFICATION_OVERRIDETool to delete an inference classification override for a specific sender. Use when removing custom Focused Inbox rules that were previously set.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the signed-in user.
string
required
The unique identifier of the inference classification override to delete. This ID can be obtained from the List Inference Classification Overrides action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_ME_MAIL_FOLDER_CHILD_FOLDERTool to delete a child mail folder from a parent mail folder. Use when removing nested mail folders from a user’s mailbox.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the signed-in user.
string
required
The unique identifier of the parent mail folder. This ID can be obtained from List Mail Folders action.
string
required
The unique identifier of the child mail folder to delete. This ID can be obtained from List Mail Folders action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_ME_MAIL_FOLDER_CHILD_FOLDER_PERMANENTLYPermanently deletes a child mail folder from a parent mail folder. Unlike standard DELETE, this action makes the folder permanently unrecoverable. Use when you need to ensure a child folder cannot be restored from deleted items.

Input Parameters

string
The unique identifier of the user. Use ‘me’ for the authenticated user, or provide the user’s email address (UPN) or their Azure AD object ID.
string
required
Unique identifier of the parent mail folder. Must be a valid mail folder ID obtained from ‘List Mail Folders’ or ‘List Child Mail Folders’.
string
required
Unique identifier of the child folder to permanently delete. The folder will be permanently deleted and cannot be recovered by the user. Must be obtained from ‘List Child Mail Folders’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_ME_MAIL_FOLDER_MESSAGE_RULETool to delete a message rule from a specific mail folder. Use when you need to remove an email automation rule from a folder.

Input Parameters

string
required
The unique identifier of the message rule to delete. Must be obtained from a list or get operation on message rules.
string
The unique identifier of the user. Use ‘me’ as alias for the authenticated user, or provide a specific user ID or user principal name.
string
required
The unique identifier of the mail folder containing the message rule. Can be a well-known folder name (e.g., ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’) or a folder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_ME_MAIL_FOLDERS_CHILD_FOLDERS_MESSAGES_EXTENSDelete user message extension

Input Parameters

string
required
The unique identifier of the user or ‘me’ for the authenticated user.
string
required
The unique identifier of the message that has the extension to delete.
string
required
The unique identifier of the extension to delete. Can be the full extension ID (e.g., Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.TestExtension) or just the extension name (e.g., Com.Contoso.TestExtension).
string
required
The unique identifier of the mail folder containing the child folder.
string
required
The unique identifier of the child folder within the mail folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_ME_MAIL_FOLDERS_MESSAGES_ATTACHMENTSDEPRECATED: Use OUTLOOK_DELETE_MESSAGE_ATTACHMENT instead. Tool to delete an attachment from a message in a mail folder. Use when removing file or item attachments from messages in Outlook mail folders.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the authenticated user or a specific user ID for S2S (app-only) authentication.
string
required
The unique identifier of the message containing the attachment. Must be a valid base64-encoded message ID obtained from listing messages or search operations.
string
required
The unique identifier of the attachment to delete. Must be a valid attachment ID obtained from listing message attachments.
string
required
The unique identifier of the mail folder containing the message. Can be a well-known name (‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’) or a base64-encoded folder ID obtained from listing mail folders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_ME_MAIL_FOLDERS_MESSAGES_EXTENSIONSTool to delete a navigation property extension from a message within a mail folder. Use when removing custom extension data from a message.

Input Parameters

string
The user ID or principal name. Required for app-only (S2S) authentication. If not provided, uses ‘me’ for delegated authentication.
string
required
The unique identifier of the message that has the extension to delete.
string
required
The unique identifier of the extension to delete. Can be the full extension ID (e.g., Microsoft.OutlookServices.OpenTypeExtension.Com.Composio.TestExtension) or just the extension name (e.g., Com.Composio.TestExtension).
string
required
The unique identifier of the mail folder containing the message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_ME_MESSAGES_ATTACHMENTSTool to delete an attachment from a message. Use when removing file or item attachments from messages in Outlook.

Input Parameters

string
The unique identifier or user principal name (email) of the user. Required for S2S (app-only) authentication. Can be either a GUID (e.g., ‘43f0c14d-bca8-421f-b762-c3d8dd75be1f’) or an email address (e.g., ‘user@example.com’). If not provided, defaults to ‘/me’ for delegated authentication.
string
required
The unique identifier of the message containing the attachment. Must be a valid base64-encoded message ID obtained from listing messages or search operations.
string
required
The unique identifier of the attachment to delete. Must be a valid attachment ID obtained from listing message attachments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_MESSAGETool to permanently delete an Outlook email message by its message_id. Use when removing unwanted messages, cleaning up drafts, or performing mailbox maintenance.

Input Parameters

string
The UPN (User Principal Name) or ID of the user; use ‘me’ for the signed-in user.
string
required
Unique identifier of the message to delete, typically obtained from ‘List Emails’ or ‘Search Messages’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_MESSAGE_ATTACHMENTDelete an attachment from a message in a mail folder or its child folder.

Input Parameters

string
User’s email address, UPN, or ‘me’ for the currently authenticated user.
string
required
The unique identifier of the message containing the attachment. Must be a valid message ID obtained from listing messages, not a folder ID.
string
required
The unique identifier of the attachment to delete. Obtain this ID from listing message attachments.
string
required
The unique identifier of the mail folder. Can be a well-known name (‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’) or a folder ID obtained from listing mail folders.
string
The unique identifier of the child folder within the mail folder. If provided, targets the message inside mailFolders/{id}/childFolders/{id}. If omitted, targets the message directly inside mailFolders/{id}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_MESSAGE_EXTENSIONTool to delete an open extension from an Outlook message. Use when removing custom extension data that is no longer needed from a message.

Input Parameters

string
The UPN (User Principal Name) or ID of the user; use ‘me’ for the signed-in user.
string
required
The unique identifier of the message containing the extension to delete.
string
required
The unique identifier of the extension to delete. Can be the full extension ID (e.g., Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.TestExtension) or just the extension name (e.g., Com.Contoso.TestExtension).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_MESSAGE_PERMANENTLY_FROM_FOLDERDEPRECATED: Use OUTLOOK_PERMANENT_DELETE_MESSAGE instead. Tool to permanently delete a message from a specific mail folder. Use when you need to irreversibly delete a message with explicit folder context. The message is moved to the Purges folder and cannot be recovered.

Input Parameters

string
required
The unique identifier of the user. This can be the user’s UPN (User Principal Name) or the user object ID.
string
required
The unique identifier of the message to permanently delete. The message will be moved to the Purges folder and cannot be recovered.
string
required
The unique identifier of the mail folder containing the message to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_PRIMARY_CALENDAR_PERMISSIONDelete a calendar permission from a user’s primary calendar to revoke calendar sharing access.

Input Parameters

string
required
The user ID or principal name of the user whose calendar permission to delete. Use ‘me’ for the authenticated user or provide a specific user ID/UPN.
string
required
The unique identifier of the calendar permission to delete. This ID can be obtained from listing calendar permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_TODO_TASKTool to permanently delete a task from a Microsoft To Do task list. Use when removing a task that is no longer needed. This action cannot be undone.

Input Parameters

string
required
The unique identifier of the task to delete. Obtain this from List To Do tasks or Create To Do task.
string
User ID or userPrincipalName. Use ‘me’ for the signed-in user (delegated auth) or a specific user ID for app-only (S2S) authentication.
string
required
The unique identifier of the task list that contains the task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_USER_CALENDAR_EVENT_PERMANENTLYTool to permanently delete a calendar event from a specific user’s calendar. Use when you need to ensure an event cannot be restored from deleted items.

Input Parameters

string
The user’s email address, UPN, or ‘me’ for the currently authenticated user.
string
required
The unique identifier of the calendar event to permanently delete. The event will be permanently deleted and cannot be recovered by the user.
string
required
The unique identifier of the calendar containing the event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_USER_CHILD_FOLDER_CONTACTTool to delete a contact from a child folder in a user’s contact folder. Use when you need to remove a contact from a specific child folder within a contact folder.

Input Parameters

string
required
The user ID or userPrincipalName of the contact folder owner. Use ‘me’ for the authenticated user.
string
required
Identifier of the contact to be deleted from the child folder. Must be obtained from ‘List Contacts’ or ‘Get Contact’.
string
required
Identifier of the child folder within the parent contact folder containing the contact to delete. Must be a valid child folder ID.
string
required
Identifier of the parent contact folder. Must be a valid contact folder ID obtained from ‘Get Contact Folders’ or ‘List Contact Folders’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_USER_CHILD_FOLDER_MESSAGE_PERMANENTLYTool to permanently delete a message from a user’s child mail folder in Outlook. Unlike standard DELETE, this action makes the message unrecoverable by moving it to the Purges folder in the dumpster. Use when you need to ensure a message in a nested folder cannot be restored from deleted items.

Input Parameters

string
User’s email address, UPN, or ‘me’ for the currently authenticated user.
string
required
The unique identifier of the message to permanently delete from the child folder. The message will be moved to the Purges folder in the dumpster and cannot be recovered by the user. Typically a base64-encoded string obtained from list messages or search messages actions.
string
required
The ID or well-known name of the parent mail folder. Common well-known names include: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’. For folder IDs, use base64-encoded strings (e.g., ‘AAMkAGI0ZjExAAA=’) obtained from list mail folders actions.
string
required
The ID of the child folder containing the message to permanently delete. Must be a base64-encoded folder ID (e.g., ‘AAMkADAwATMwMAExAAA=’) obtained from list child folders actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_USER_CONTACT_EXTENSIONDeletes an extension from a contact in a user’s child contact folder. This tool is deprecated.

Input Parameters

string
required
The unique identifier of the user whose contact extension to delete. Can be the user’s email address or the user’s object ID.
string
required
The unique identifier of the contact that has the extension to delete.
string
required
The unique identifier of the extension to delete. Can be the full extension ID (e.g., Microsoft.OutlookServices.OpenTypeExtension.com.contoso.roamingSettings) or just the extension name (e.g., com.contoso.roamingSettings).
string
required
The unique identifier of the child contact folder containing the contact.
string
required
The unique identifier of the parent contact folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_USER_EVENT_PERMANENTLYTool to permanently delete a calendar event for a specified user. Use when you need to ensure an event cannot be restored from deleted items.

Input Parameters

string
required
The user ID or userPrincipalName of the calendar owner. Use ‘me’ for the authenticated user.
string
required
The unique identifier of the calendar event to permanently delete. The event will be permanently deleted and cannot be recovered by the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_USER_MAIL_FOLDER_PERMANENTLYPermanently deletes a mail folder for a specific user. Unlike standard DELETE, this action makes the folder permanently unrecoverable. Use when you need to ensure a user’s folder cannot be restored from deleted items.

Input Parameters

string
required
The user ID or user principal name (email address) of the user whose mail folder should be permanently deleted. This is required to identify which user’s mailbox contains the folder.
string
required
Unique identifier of the mail folder to permanently delete. The folder will be permanently deleted and cannot be recovered by the user. Use ‘List Mail Folders’ action to obtain the folder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DELETE_USER_MESSAGE_ATTACHMENTDeprecated. Deletes an attachment from a message in the authenticated user’s mailbox or a specified user’s mailbox.

Input Parameters

string
The user’s email address, userPrincipalName, or user ID. Use ‘me’ for the authenticated user.
string
required
The unique identifier of the message containing the attachment to delete. Typically obtained from listing messages or search operations.
string
required
The unique identifier of the attachment to delete. Can be obtained from listing message attachments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DISMISS_CALENDAR_EVENT_REMINDERTool to dismiss a reminder for a specific event in a user’s calendar. Use when you need to turn off or remove a reminder alert for an event in a specific user’s calendar.

Input Parameters

string
required
The unique identifier or user principal name (UPN) of the user. Can be ‘me’ for the authenticated user.
string
required
The unique identifier of the event whose reminder should be dismissed.
string
required
The unique identifier of the calendar containing the event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DISMISS_EVENT_REMINDERDismiss a reminder for a specific event in the signed-in user’s or specified user’s default calendar.

Input Parameters

string
The unique identifier or email of the user. Required for S2S authentication with app-only permissions.
string
required
The unique identifier of the calendar event whose reminder should be dismissed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DISMISS_EVENT_REMINDER_FROM_GROUPTool to dismiss a reminder for an event in a user’s calendar within a calendar group. Use when you need to turn off a reminder for an event in a specific user’s calendar group.

Input Parameters

string
required
The unique identifier of the user or userPrincipalName. Use ‘me’ for the signed-in user.
string
required
The unique identifier of the event whose reminder should be dismissed.
string
required
The unique identifier of the calendar within the calendar group.
string
required
The unique identifier of the calendar group containing the calendar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DISMISS_USER_EVENT_REMINDERTool to dismiss a reminder for a specific user’s calendar event. Use when you need to turn off or remove a reminder alert for an event in a user’s calendar.

Input Parameters

string
required
The user ID or userPrincipalName (email address) of the calendar owner, identifying whose event reminder should be dismissed.
string
required
The unique identifier of the calendar event whose reminder should be dismissed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DOWNLOAD_GROUP_POST_ATTACHMENTDownload raw file content or item-attachment MIME content from a Microsoft 365 group conversation post. Reference attachments are not supported.

Input Parameters

string
required
Opaque ID of the conversation post containing the attachment.
string
required
Opaque ID of the Microsoft 365 group containing the post.
string
required
Filename to assign to the downloaded content, including an extension when known.
string
required
Opaque ID of the conversation thread containing the post.
string
required
Opaque attachment ID returned with the post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DOWNLOAD_OUTLOOK_ATTACHMENTDownloads a specific file attachment from an email message in a Microsoft Outlook mailbox; the attachment must contain ‘contentBytes’ (binary data) and not be a link or embedded item. High-volume parallel calls may trigger HTTP 429 responses; honor the Retry-After header and use exponential backoff.

Input Parameters

string
The user’s UPN (User Principal Name) or ‘me’ for the authenticated user. This identifies the mailbox where the message is located.
string
required
The desired filename for the downloaded attachment. This name will be assigned to the.
string
required
The unique identifier of the email message that contains the attachment to be downloaded. This ID is typically obtained when listing or retrieving messages.
string
required
The Microsoft Graph API attachment identifier (NOT the filename). This is a base64-encoded opaque string returned in the ‘id’ field when listing attachments via the LIST_OUTLOOK_ATTACHMENTS action. Must be the exact value from the API response, not the attachment’s display name or filename. Always use the exact attachment_id/message_id pair returned together from LIST_OUTLOOK_ATTACHMENTS — an attachment_id is bound to its specific message_id and cannot be used with a different message_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_DOWNLOAD_PROFILE_PHOTODownload the signed-in user’s profile-photo bytes at a fixed size.

Input Parameters

string ("48x48" | "64x64" | "96x96" | "120x120" | "240x240" | "360x360" | "432x432" | "504x504" | "648x648")
required
The fixed Microsoft 365 profile-photo size to download.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_FIND_MEETING_TIMESSuggest meeting times based on organizer and attendee availability, time constraints, and duration requirements. Requires delegated access with a work or school account.

Input Parameters

string
User ID or User Principal Name. Use ‘me’ for the authenticated user.
array
List of attendees or resources for the meeting. Empty list searches only organizer’s availability.
integer
Maximum number of meeting time suggestions to return.
string
Preferred timezone for the response (sets Prefer header with outlook.timezone). If not specified, defaults to UTC.
object
Time restrictions for the meeting.
string
Meeting length in ISO 8601 duration format (e.g., ‘PT1H’ for 1 hour, ‘PT30M’ for 30 minutes). Default: 30 minutes.
object
Meeting location requirements.
boolean
If true, organizer doesn’t need to attend. Default: false.
boolean
If true, include reasons for each suggestion. Default: false.
number
Minimum confidence percentage (0-100) for suggestions. Default: 50.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_FORWARD_MESSAGETool to forward a message. Use when you need to send an existing email to new recipients.

Input Parameters

string
An optional comment to include with the forwarded message.
string
The user’s email address or alias ‘me’ to indicate the authenticated user. Specifies which mailbox to use.
string
required
The unique identifier of the message to forward. Must be a valid Outlook message ID (Base64-encoded string, e.g., ‘AAMkAGI2TAAA=’). Obtain this from OUTLOOK_LIST_MESSAGES or OUTLOOK_GET_MESSAGE actions. Message IDs are mailbox-specific.
array
required
List of email addresses to forward the message to. Provide each address separately.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_FORWARD_USER_CALENDAR_EVENTTool to forward a calendar event from a specific user’s calendar to new recipients. Use when you need to share an event from a particular calendar with additional people.

Input Parameters

string
An optional comment to include with the forwarded event invitation.
string
The user identifier. Use ‘me’ for the authenticated user, or provide a Microsoft 365 User Principal Name (e.g., user@contoso.com) or Azure AD object ID.
string
required
The unique identifier of the calendar event to forward. Must be a valid Outlook event ID obtained from list or get event actions.
string
required
The unique identifier of the calendar containing the event to forward. Obtain this from list calendars actions.
array
required
List of recipients to forward the event to. Can provide email addresses as strings (e.g., ‘alice@example.com’) or as objects with ‘address’ and optional ‘name’ fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CALENDARRetrieves a specific calendar by ID from the signed-in user’s calendars. This tool is deprecated.

Input Parameters

string
required
The unique identifier of the calendar to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CALENDAR_EVENTTool to retrieve a specific event from a specified calendar. Use when you need to get details of an event that belongs to a specific calendar in the user’s mailbox.

Input Parameters

string
The user ID (GUID) or email address of the user. Required for app-only (S2S) authentication. If not provided, uses the authenticated user context (/me).
string
required
The unique identifier of the event within the calendar.
string
required
The unique identifier of the calendar.
boolean
When true, retrieves and normalizes the event’s Microsoft Purview sensitivity label from a filtered msip_labels expansion in the same Graph request. This is distinct from the event’s built-in sensitivity field and from a Teams online meeting sensitivity-label assignment. Requires Calendars.Read or Calendars.ReadWrite. Treat a returned status of unknown as fail-closed before using the event content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CALENDAR_EVENT_ATTACHMENTTool to retrieve a specific attachment from an event within a calendar. Use when you need to access attachment content from a calendar event.

Input Parameters

string
The user ID or user principal name (email) to access calendars on behalf of. Required for S2S (app-only) authentication. If not provided, defaults to ‘me’ for delegated authentication.
string
required
The unique identifier of the calendar event containing the attachment.
string
required
The unique identifier of the calendar.
string
required
The unique identifier of the attachment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CALENDAR_FROM_EVENTTool to retrieve the parent calendar that contains a specific event. Use when you need to get calendar details for a specific event in a calendar.

Input Parameters

string
The user ID or user principal name (email address). Required for S2S (app-only) authentication. Use ‘me’ or omit for delegated authentication.
string
required
The unique identifier of the event within the calendar.
string
required
The unique identifier of the calendar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CALENDAR_FROM_GROUPTool to retrieve a specific calendar from a calendar group in Microsoft Outlook. Use when you need to get details of a calendar that belongs to a specific calendar group.

Input Parameters

string
required
User ID or userPrincipalName of the user whose calendar to retrieve.
string
required
The unique identifier of the calendar within the calendar group.
string
required
The unique identifier of the calendar group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CALENDAR_GROUPRetrieve the properties of a specific Outlook calendar group by its ID, with optional property selection.

Input Parameters

string
Comma-separated list of related entities to expand in the response (OData $expand query parameter).
string
Comma-separated list of properties to include in the response (OData $select query parameter).
string
User ID or userPrincipalName. Use ‘me’ for the signed-in user.
string
required
The unique identifier of the calendar group to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CALENDAR_GROUP_CALENDAR_EVENT_EXTENSIONRetrieve an open extension’s identifiers and metadata from an event in a specified calendar group and calendar. The response does not include arbitrary custom extension data.

Input Parameters

string
The unique identifier of the user (required for S2S/application authentication). Can be user ID (GUID) or userPrincipalName (email).
string
required
The unique identifier of the calendar event containing the extension.
string
required
The unique identifier of the calendar within the calendar group.
string
required
The unique identifier of the extension to retrieve. Can be the full extension ID (e.g., Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.TestExtension) or just the extension name (e.g., Com.Contoso.TestExtension).
string
required
The unique identifier of the calendar group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CALENDAR_GROUP_EVENT_ATTACHMENTDeprecated: Use OUTLOOK_GET_USER_CALENDAR_GROUP_EVENT_ATTACHMENT instead, which supports both /me and /users/{user_id} endpoints.

Input Parameters

string
The unique identifier of the user. Can use ‘me’ as shortcut for authenticated user.
string
required
The unique identifier of the calendar event containing the attachment.
string
required
The unique identifier of the calendar within the calendar group.
string
required
The unique identifier of the attachment to retrieve.
string
required
The unique identifier of the calendar group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CALENDAR_GROUP_SCHEDULERetrieve free/busy availability for specified users, distribution lists, or resources over a time period using a user’s calendar within a calendar group.

Input Parameters

string
required
The ID or userPrincipalName of the user. Use ‘me’ for the authenticated user or a user’s email address.
object
required
The date, time, and time zone that the period ends. The period can be up to 62 days.
array
required
A collection of SMTP addresses of users, distribution lists, or resources to get availability information for. Maximum of 20 addresses.
object
required
The date, time, and time zone that the period starts.
string
required
The ID of the calendar within the calendar group.
string
required
The ID of the calendar group containing the calendar.
integer
Duration of a time slot in an availabilityView in minutes. Default is 30, minimum is 5, maximum is 1440.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CALENDAR_PERMISSIONRetrieve a specific permission for a user’s default calendar, including the recipient or delegate and permission level.

Input Parameters

string
required
User ID or userPrincipalName of the user whose calendar permission to retrieve.
string
required
The unique identifier of the calendar permission to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CALENDAR_PERMISSION_FROM_CALENDARTool to retrieve a specific calendar permission from a user’s calendar. Use when you need to check who has access to a specific user’s calendar and their permission level.

Input Parameters

string
required
The unique identifier of the user. Cannot use ‘me’ shortcut - must be actual user ID or userPrincipalName.
string
required
The unique identifier of the calendar.
string
required
The unique identifier of the calendar permission to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CALENDAR_SCHEDULETool to get free/busy schedule information for users, distribution lists, or resources. Use when you need to check availability for specific people or resources during a time period.

Input Parameters

string
The unique identifier (GUID) or email address of the user whose calendar to query. For delegated auth, omit this (or use None, not ‘me’) to query the authenticated user’s calendar. For S2S (app-only) auth, this is required.
object
required
The end date, time, and time zone for the period to retrieve schedules. Period can be up to 62 days from start.
array
required
A collection of SMTP addresses of users, distribution lists, or resources to get availability information for. Maximum of 20 addresses.
object
required
The start date, time, and time zone for the period to retrieve schedules. Period can be up to 62 days.
integer
Duration of a time slot in minutes. Minimum: 5, Maximum: 1440. Default: 30.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CALENDAR_VIEWGet events ACTIVE during a time window (includes multi-day events). Use for “what’s on my calendar today/this week” or availability checks. Returns events overlapping the time range. For keyword search or filters by category, use OUTLOOK_LIST_EVENTS instead.

Input Parameters

integer
Maximum number of events to retrieve.
integer
Number of events to skip before returning the page (OData $skip).
array
List of event properties to return. Defaults to commonly-needed fields excluding the full HTML body. To include the full body content, explicitly add ‘body’ to this list.
string
OData ordering expression for events, for example ‘start/dateTime asc’.
string
Email address of the target user (or ‘me’ for authenticated user).
string
Timezone for event times in the response only; the input window is always interpreted from the offset in start_datetime/end_datetime. Must be an IANA timezone name (e.g., ‘America/New_York’, ‘Europe/London’, ‘Asia/Kolkata’) or Windows timezone identifier (e.g., ‘Pacific Standard Time’, ‘India Standard Time’). UTC offsets like ‘+05:30’ or ‘GMT+5’ are NOT supported. Defaults to UTC.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
Optional ID of a specific calendar to query. Must be a calendar identifier (format like ‘AAMkAGI2TG93AAA=’), NOT an email address. If not provided, uses the primary calendar. Get calendar IDs using LIST_CALENDARS action.
string
required
The end date and time of the time range, represented in ISO 8601 format. For example, ‘2019-11-08T20:00:00-08:00’ or ‘2024-12-31T23:59:59Z’.
string
required
The start date and time of the time range, represented in ISO 8601 format. For example, ‘2019-11-08T19:00:00-08:00’ or ‘2024-01-01T00:00:00Z’.
boolean
When true, retrieves and normalizes the Microsoft Purview sensitivity label applied to each calendar event. This is distinct from the event’s built-in sensitivity field and any Teams meeting label. Preserved in next_page_token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CHILD_FOLDER_MESSAGETool to retrieve a specific email message from a child mail folder. Use when you need to access a message in a nested folder hierarchy.

Input Parameters

array
List of message properties to include in the response. OData $select parameter. Reduces data transfer and improves performance. Common fields: id, subject, from, toRecipients, ccRecipients, receivedDateTime, sentDateTime, body, bodyPreview, hasAttachments, webLink, internetMessageHeaders, isRead, importance, categories. Leave empty to return all fields.
string
User’s email address, UPN, or ‘me’ for the currently authenticated user.
string
required
Unique ID of the message to retrieve. Must be obtained from OUTLOOK_LIST_MAIL_FOLDER_MESSAGES, OUTLOOK_QUERY_EMAILS, or OUTLOOK_SEARCH_MESSAGES (use hitId from search results). The message must exist in the specified child folder.
string
required
The ID or well-known name of the parent mail folder. Common well-known names include: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. For custom folders, use the actual folder ID (a base64-encoded string like ‘AAMkAGI0ZjExAAA=’) obtained from OUTLOOK_LIST_MAIL_FOLDERS.
string
required
The ID of the child mail folder containing the message. This must be a base64-encoded folder ID (e.g., ‘AQMkADAwATMwMAExLTlmNjktOWVmYS0wMAItMDAKAC4=’) obtained from OUTLOOK_LIST_CHILD_MAIL_FOLDERS. Well-known names are NOT valid for child folders.
boolean
When true, retrieves and normalizes the message’s Microsoft Purview sensitivity label in the same Graph request. Requires Mail.Read. Treat status unknown as fail-closed before using message content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CHILD_FOLDER_MESSAGE_CONTENTTool to get the MIME content of a message from a child mail folder. Use when you need to download the raw MIME format of an email message for analysis or archival.

Input Parameters

string
User’s email address, UPN, or ‘me’ for the currently authenticated user. Use ‘me’ for delegated authentication or provide a specific user ID/email for S2S (app-only) authentication.
string
required
The unique identifier of the message whose MIME content to retrieve. Must be obtained from message listing or query operations.
string
required
The unique identifier of the parent mail folder. Must be obtained from ‘List Mail Folders’ or other mail folder operations.
string
required
The unique identifier of the child mail folder within the parent folder. Must be obtained from ‘List Child Mail Folders’ or other folder operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CHILD_MAIL_FOLDERTool to retrieve a specific child mail folder from a parent mail folder. Use when you need details about a specific subfolder within a folder hierarchy.

Input Parameters

string
Comma-separated list of mailFolder properties to include in the response. Valid properties include: id, displayName, parentFolderId, childFolderCount, unreadItemCount, totalItemCount, sizeInBytes, isHidden. Example: ‘id,displayName,childFolderCount’.
string
User’s id, userPrincipalName, or ‘me’ for the signed-in user.
string
required
The ID or well-known name of the parent mail folder. Common well-known names include: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. For folder IDs, obtain them from OUTLOOK_LIST_MAIL_FOLDERS or previous childFolders responses. Folder IDs are base64-encoded strings (e.g., ‘AAMkAGI0ZjExAAA=’) that are mailbox-specific and must come from the same user’s mailbox.
string
required
The unique ID of the child folder to retrieve. Obtain child folder IDs from OUTLOOK_LIST_CHILD_MAIL_FOLDERS or previous API responses. Child folder IDs are base64-encoded strings that are mailbox-specific and must come from the same user’s mailbox.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CONTACT_EXTENSIONRetrieves an open extension from a contact in a specified contact folder in Microsoft Graph. The response contains extension identification metadata, not the extension’s custom data fields.

Input Parameters

string
The user ID (GUID) or user principal name (email) for S2S authentication. If not provided, uses ‘/me’ endpoint for delegated authentication.
string
required
The unique identifier of the contact that has the extension.
string
required
The unique identifier of the extension to retrieve. Can be the full extension ID (e.g., Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.TestExtension) or just the extension name (e.g., Com.Contoso.TestExtension).
string
required
The unique identifier of the contact folder containing the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CONTACT_FOLDERTool to retrieve a specific contact folder by ID. Use when you need details about a particular contact folder in the user’s mailbox.

Input Parameters

string
OData query parameter to select specific properties, e.g., ‘id,displayName’.
string
The ID or userPrincipalName of the user. Required for app-only authentication (S2S). If not provided, uses ‘/me’ endpoint for delegated authentication.
string
required
The ID of the contact folder to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CONTACT_FOLDERSTool to retrieve contact folders from a specific user’s mailbox. Use when you need to list or browse contact folders for a given user.

Input Parameters

integer
Maximum number of contact folders to return. OData $top parameter.
integer
Number of contact folders to skip for pagination. OData $skip parameter.
array
Related entities to expand inline. OData $expand parameter.
string
OData filter expression to filter the contact folders, e.g., startswith(displayName,‘A’).
array
List of properties to include in the response. OData $select parameter.
array
List of properties to order results by. OData $orderby parameter.
string
required
User principal name or ID. Use ‘me’ for the authenticated user.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CONTACT_FROM_FOLDERTool to retrieve a specific contact from a contact folder by its ID. Use when you need to access contact details from a specific folder rather than the default contacts location.

Input Parameters

array
List of relationships to expand and include in the response. Leave empty for default behavior.
array
List of specific contact properties to include in the response, e.g., [‘displayName’, ‘emailAddresses’]. Leave empty to get all properties.
string
User’s principal name (e.g., ‘AdeleV@contoso.onmicrosoft.com’) or ‘me’ for the authenticated user. Using ‘me’ is recommended for accessing one’s own contacts.
string
required
Unique identifier for the contact within the specified contact folder.
string
required
Unique identifier of the contact folder containing the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_CONTACT_PHOTO_METADATARetrieve dimensions and optional media metadata for a contact’s photo.

Input Parameters

string
The Microsoft Entra user ID or user principal name. Required for app-only (S2S) authentication. If omitted, uses the signed-in user.
string
required
The unique identifier of the contact whose photo metadata to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_DRAFTS_MAIL_FOLDERTool to get the drafts mail folder. Use when you need to retrieve details about the drafts folder such as item counts and folder ID.

Input Parameters

string
Comma-separated list of properties to include in the response. Valid properties: id, displayName, parentFolderId, childFolderCount, unreadItemCount, totalItemCount, sizeInBytes, isHidden.
string
User’s id, userPrincipalName, or ‘me’ for the signed-in user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_DRIVE_ITEMRetrieve metadata for one file or folder from a Microsoft Graph drive.

Input Parameters

array
DriveItem relationships to include as an OData $expand list.
array
DriveItem properties to return as an OData $select list.
string
required
Opaque identifier of the file or folder to retrieve.
string
required
Opaque identifier of the Microsoft Graph drive containing the item.
string
Optional ETag or cTag for a conditional request. Microsoft Graph returns 304 when the item has not changed.
boolean
Include deleted items when true. This is supported only for OneDrive Personal items addressed by item ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_EVENTRetrieves the full details of a specific calendar event by its ID from a user’s Outlook calendar, provided the event exists.

Input Parameters

string
The user’s primary SMTP address, user principal name (UPN), or the alias ‘me’ (for the signed-in user) to identify the calendar owner.
string
required
The unique identifier of the calendar event to retrieve.
boolean
When true, retrieves and normalizes the event’s Microsoft Purview sensitivity label from a filtered msip_labels expansion in the same Graph request. This is distinct from the event’s built-in sensitivity field and from a Teams online meeting sensitivity-label assignment. Requires Calendars.Read or Calendars.ReadWrite. Treat a returned status of unknown as fail-closed before using the event content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_EVENT_ATTACHMENTRetrieve a specific attachment from an Outlook calendar event by attachment ID. The response includes attachment details and, for file attachments, may include base64-encoded content.

Input Parameters

string
The user’s primary SMTP address, UPN, or ‘me’ for the signed-in user.
string
required
The unique identifier of the calendar event containing the attachment.
string
required
The unique identifier of the attachment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_EVENT_CALENDAR_FROM_GROUPTool to retrieve the calendar that contains a specific event within a calendar group. Use when you need to get calendar details for an event in a calendar group.

Input Parameters

string
The user ID (GUID or email) for S2S authentication. If not provided, uses /me endpoint for delegated auth.
string
required
The unique identifier of the event within the calendar.
string
required
The unique identifier of the calendar within the calendar group.
string
required
The unique identifier of the calendar group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_GROUPRetrieve a Microsoft Graph group by ID.

Input Parameters

string
Group properties to return as a list or comma-separated string (OData $select).
string
required
Unique identifier of the Microsoft Graph group to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_GROUP_CALENDARRetrieve metadata for a Microsoft 365 group’s default calendar using delegated work or school account access.

Input Parameters

string
Calendar properties to return as a list or comma-separated string (OData $select).
string
required
Opaque ID of the Microsoft 365 group that owns the calendar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_GROUP_EVENTRetrieve one calendar event owned by a Microsoft 365 group using delegated access.

Input Parameters

string
Event relationships to include as a list or comma-separated string (OData $expand).
string
Event properties to return as a list or comma-separated string (OData $select).
string
required
Opaque ID of the group event to retrieve.
string
required
Opaque ID of the Microsoft 365 group that owns the event.
string
Outlook time zone used to format the returned event start and end times.
string ("text" | "html")
Preferred format for the returned event body: text or html.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_GROUP_POST_ATTACHMENTRetrieve one attachment from a Microsoft 365 group conversation post using delegated access.

Input Parameters

string
OData $expand expression. For an item attachment, use ‘microsoft.graph.itemattachment/item’ to include the attached item.
string
required
Opaque ID of the conversation post containing the attachment.
string
required
Opaque ID of the Microsoft 365 group containing the post.
string
required
Opaque ID of the conversation thread containing the post.
string
required
Opaque ID of the attachment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_INFERENCE_CLASSIFICATIONTool to get inference classification settings for the authenticated user. Use when you need to retrieve the Focused Inbox configuration and sender-specific overrides that determine message classification.

Input Parameters

string
The ID or email address of the user. Required for S2S (app-only) authentication. Use the user’s GUID or email format (e.g., ‘43f0c14d-bca8-421f-b762-c3d8dd75be1f’ or ‘user@example.com’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_MAILBOX_SETTINGSTool to retrieve mailbox settings. Use when you need to view settings such as automatic replies, time zone, and working hours for the signed-in or specified user.

Input Parameters

array
OData $select query to specify mailbox settings properties to include. Valid properties: archiveFolder, automaticRepliesSetting, dateFormat, delegateMeetingMessageDeliveryOptions, language, timeFormat, timeZone, userPurpose, workingHours.
string
The user’s unique identifier or principal name. Use ‘me’ for the signed-in user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_MAIL_DELTARetrieve incremental message changes in one mailbox folder, defaulting to Inbox. Page through initial or subsequent results using the returned next link, then store the delta link for the next synchronization.

Input Parameters

integer
Maximum number of items to return per page. For first run without delta_token, use top=50 or top=100 to limit results. First delta call without token returns all messages in folder. Paginate through results using @odata.nextLink, then store @odata.deltaLink for next sync.
array
Navigation properties to expand inline. Supported values: ‘attachments’, ‘multiValueExtendedProperties’, ‘singleValueExtendedProperties’. Regular properties (body, from, toRecipients, etc.) cannot be expanded and will cause errors.
array
List of message properties to include (e.g. [‘subject’,‘receivedDateTime’]). Delta sync has property limitations due to response size constraints. Not available in delta: internetMessageHeaders, body (full), attachments (full content). Available: id, subject, from, toRecipients, ccRecipients, bccRecipients, receivedDateTime, sentDateTime, isRead, isDraft, importance, hasAttachments, categories, conversationId, flag, webLink, bodyPreview (first 255 chars).
string
User identifier: ‘me’ for the signed-in user or the user’s email/UPN.
string
Mail folder identifier (folder GUID) or well-known folder name. Well-known names (case-insensitive): ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘outbox’, ‘archive’, ‘clutter’, ‘conversationhistory’. For custom folders, use the folder ID GUID from LIST_MAIL_FOLDERS. Defaults to ‘inbox’ when omitted.
string
Skip token for paging through large result sets during initial sync. Accepts either the full @odata.nextLink URL or just the bare token value. Keep paginating until you receive ‘@odata.deltaLink’ instead of nextLink. When using sensitivity-label enrichment, resend include_sensitivity_label=true with this token. Mutually exclusive with delta_token - only one should be provided per request.
string
Delta token from a previous call to get only changes since that state. Accepts either the full @odata.deltaLink URL or just the bare token value. If omitted or invalid (placeholders like <token> are ignored), performs initial sync. Use top parameter on first run to limit results. Response includes @odata.deltaLink - store this for subsequent calls. When using sensitivity-label enrichment, resend include_sensitivity_label=true with this token. Mutually exclusive with skip_token - only one should be provided per request.
boolean
When true, retrieves and normalizes Microsoft Purview sensitivity labels for delta items through Microsoft Graph JSON batches capped at 20 requests per batch. Requires Mail.Read. Treat status unknown as fail-closed before using message content. Repeat this flag on every call that uses skip_token or delta_token because Graph tokens do not preserve this Composio-only setting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_MAIL_FOLDERRetrieve one Outlook mail folder by opaque ID or well-known name, optionally selecting only needed metadata such as display name and item counts. Supports the signed-in mailbox or an explicit user mailbox. Use OUTLOOK_LIST_MAIL_FOLDERS to discover top-level IDs and OUTLOOK_LIST_CHILD_MAIL_FOLDERS for nested IDs.

Input Parameters

string
Mail folder properties to include in the response. Pass a list (recommended) or a comma-separated string; both become one OData $select value. Valid properties: id, displayName, parentFolderId, childFolderCount, unreadItemCount, totalItemCount, sizeInBytes, isHidden.
string
User’s id, userPrincipalName, or ‘me’ for the signed-in user.
string
required
The ID or well-known name of the mail folder to retrieve. ONLY these specific well-known names are valid as string names: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. Arbitrary folder names (e.g., ‘workjournal’) are NOT valid. If the folder is not one of these well-known names, you MUST use the actual folder ID - a base64-encoded string (e.g., ‘AAMkAGI0ZjExAAA=’) obtained from OUTLOOK_LIST_MAIL_FOLDERS or OUTLOOK_LIST_CHILD_MAIL_FOLDERS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_MAIL_FOLDER_MESSAGETool to retrieve a specific message from a mail folder by its ID. Use when you need to fetch full message details including subject, body, sender, recipients, timestamps, and other metadata from a specific mail folder.

Input Parameters

array
Comma-separated list of message properties to include in the response. Valid properties include: id, subject, from, toRecipients, ccRecipients, bccRecipients, receivedDateTime, sentDateTime, hasAttachments, importance, isRead, body, bodyPreview, categories, conversationId, flag, internetMessageHeaders, parentFolderId, replyTo, sender, webLink, isDraft, isReadReceiptRequested, isDeliveryReceiptRequested, changeKey, createdDateTime, lastModifiedDateTime, inferenceClassification. Leave empty to return all fields.
string
User’s id, userPrincipalName, or ‘me’ for the signed-in user.
string
required
The unique ID of the message to retrieve. Accepts message IDs from: OUTLOOK_LIST_MESSAGES (message.id), OUTLOOK_QUERY_EMAILS (message.id), OUTLOOK_LIST_MAIL_FOLDER_MESSAGES (message.id), or OUTLOOK_SEARCH_MESSAGES (use hitId from search results). The message must exist in the specified mail folder; otherwise, a 404 error will occur.
string
required
The ID or well-known name of the mail folder containing the message. ONLY these specific well-known names are valid as string names: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. Arbitrary folder names (e.g., ‘workjournal’) are NOT valid. If the folder is not one of these well-known names, you MUST use the actual folder ID - a base64-encoded string (e.g., ‘AAMkAGI0ZjExAAA=’) obtained from OUTLOOK_LIST_MAIL_FOLDERS or OUTLOOK_LIST_CHILD_MAIL_FOLDERS.
boolean
When true, retrieves and normalizes the message’s Microsoft Purview sensitivity label in the same Graph request. Requires Mail.Read. Treat status unknown as fail-closed before using message content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_MAIL_FOLDER_MESSAGE_RULETool to retrieve a specific message rule from a user’s mail folder. Use when you need details about an email rule in a particular user’s folder.

Input Parameters

string
required
The unique identifier of the message rule to retrieve. This can be obtained from list email rules actions.
string
required
The unique identifier of the user. Can be the user’s email address, user principal name (UPN), or user ID. Use ‘me’ for the authenticated user.
string
required
The ID or well-known name of the mail folder containing the message rule. Well-known names include: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’. For other folders, use the folder ID obtained from list mail folders actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_MAIL_TIPSTool to retrieve mail tips such as automatic replies and mailbox full status. Use when you need to check recipient status before sending mail.

Input Parameters

string
User principal name (UPN) or ‘me’ for the signed-in user.
array
required
Collection of SMTP addresses of recipients to get MailTips for.
array
required
List of mail tip types to retrieve for each recipient.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_MASTER_CATEGORIESTool to retrieve the user’s master category list. Use when you need to get all categories defined for the user.

Input Parameters

integer
Maximum number of master categories to return (OData $top).
integer
Number of master categories to skip for pagination (OData $skip).
string
OData $filter query to filter master categories.
array
OData $select query to specify properties to include.
array
OData $orderby query to order master categories by property values.
string
The user’s unique identifier or principal name. Use ‘me’ for the signed-in user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_MASTER_CATEGORYTool to retrieve properties of a specific category from the user’s master category list. Use when you need details about a specific category.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the signed-in user.
string
required
Unique identifier of the Outlook category to retrieve. This ID can be obtained from Get Master Categories action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_ME_CALENDARRetrieve properties of the default calendar for the signed-in user or a specified user.

Input Parameters

string
User ID or userPrincipalName. Use ‘me’ for the signed-in user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_ME_CONTACT_FOLDERS_CHILD_FOLDERTool to retrieve a specific child contact folder for a user by ID. Use when you need details of a child folder nested within a parent contact folder for a specific user.

Input Parameters

array
List of properties to include in the response. OData $select parameter. Valid properties: id, displayName, parentFolderId.
string
required
The unique identifier of the user. Can use ‘me’ as a shortcut for the authenticated user, or provide user ID or userPrincipalName.
string
required
The unique identifier of the child contact folder to retrieve.
string
required
The unique identifier of the parent contact folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_ME_CONTACT_FROM_CHILD_FOLDERTool to retrieve a specific contact from a nested child folder within a contact folder. Use when you need contact details from a child folder.

Input Parameters

string
Comma-separated list of relationships to expand and include in the response. OData $expand parameter.
string
Comma-separated list of properties to include in the response. OData $select parameter.
string
required
User principal name or ID of the user. Use ‘me’ for the authenticated user.
string
required
The unique identifier of the contact to retrieve.
string
required
The ID of the child folder containing the contact. For deeply nested folders, provide only the immediate parent folder ID.
string
required
The ID of the parent contact folder containing the child folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_ME_CONTACT_PHOTOTool to get the binary media content of a contact’s profile photo. Use when you need to download or retrieve a contact’s picture.

Input Parameters

string
The user ID or email address. Required for app-only (S2S) authentication. If not provided, uses ‘/me’ endpoint for delegated auth.
string
required
The unique identifier of the contact whose photo to retrieve. Must be obtained from ‘List Contacts’ or ‘Get Contact’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_ME_CONTACTSRetrieves a specific Outlook contact by its contact_id from the contacts of a specified user_id (defaults to ‘me’ for the authenticated user).

Input Parameters

string
User’s principal name (e.g., ‘AdeleV@contoso.onmicrosoft.com’) or ‘me’ for the authenticated user. Using ‘me’ is recommended for accessing one’s own contacts.
string
required
Unique identifier for the contact within the specified user’s Outlook address book.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_ME_CONTACTS_EXTENSIONSRetrieve the identifying metadata of a specific open extension on a user’s contact.

Input Parameters

string
required
The unique identifier or user principal name of the user. Use ‘me’ for the authenticated user.
string
required
The unique identifier of the contact that has the extension.
string
required
The unique identifier of the extension to retrieve. Can be the full extension ID (e.g., Microsoft.OutlookServices.OpenTypeExtension.Com.Composio.TestExtension) or just the extension name (e.g., Com.Composio.TestExtension).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_ME_EVENT_ATTACHMENTTool to retrieve a specific attachment from a user’s calendar event. Use when you need to access attachment details including content from a specific user’s event.

Input Parameters

string
required
The unique identifier of the user. Use the user’s UPN (e.g., ‘user@contoso.com’) or user ID.
string
required
The unique identifier of the calendar event containing the attachment.
string
required
The unique identifier of the attachment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_ME_EVENT_CALENDARTool to retrieve the calendar that contains a specific event. Use when you need to get calendar details for an event.

Input Parameters

string
User ID or userPrincipalName. Use ‘me’ for the signed-in user.
string
required
The unique identifier of the event. This ID can be obtained from listing calendar events or other event operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_ME_MAIL_FOLDER_MESSAGE_ATTACHMENTDEPRECATED: Use OUTLOOK_GET_USER_MESSAGES_ATTACHMENTS instead. Tool to get a specific attachment from a message in a mail folder. Use when you have the folder ID, message ID, and attachment ID.

Input Parameters

string
OData $expand parameter. Use ‘microsoft.graph.itemattachment/item’ to get the properties of the item (contact, event, or message) that is attached to the message. Can be used to expand nested attachments up to 30 levels.
string
The user ID or user principal name (email) of the user whose message attachment to retrieve. Required for S2S (app-only) authentication. If not provided, defaults to ‘me’ (authenticated user) which only works with delegated authentication. For S2S authentication with client credentials, you must provide the user_id (GUID) or email address.
string
required
The unique identifier of the email message containing the attachment. Must be a message ID obtained from OUTLOOK_LIST_MESSAGES or OUTLOOK_SEARCH_EMAILS.
string
required
The unique identifier of the attachment to retrieve. This ID is obtained from listing attachments.
string
required
The ID or well-known name of the mail folder containing the message. ONLY these specific well-known names are valid as string names: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. Arbitrary folder names (e.g., ‘workjournal’) are NOT valid. If the folder is not one of these well-known names, you MUST use the actual folder ID - a base64-encoded string (e.g., ‘AAMkAGI0ZjExAAA=’) obtained from OUTLOOK_LIST_MAIL_FOLDERS or OUTLOOK_LIST_CHILD_MAIL_FOLDERS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_ME_MAIL_FOLDERS_MESSAGES_EXTENSIONSRetrieve identifying details for a specific extension on a message in a user’s mail folder. The response does not retain arbitrary custom extension properties.

Input Parameters

string
User ID, userPrincipalName, or ‘me’ for the authenticated user.
string
required
The unique identifier of the message containing the extension.
string
required
The unique identifier of the extension. Can be the extension name (e.g., ‘Com.Contoso.Test’) or the fully qualified name (e.g., ‘Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.Test’).
string
required
The unique identifier of the mail folder containing the message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_ME_MESSAGE_MIME_CONTENTTool to get the MIME content of a message. Use when you need to download the raw MIME format of an email message for analysis or archival.

Input Parameters

string
The user ID or principal name (email) of the user whose message to retrieve. Required when using app-only (S2S) authentication. If not provided, defaults to ‘/me’ endpoint for delegated authentication.
string
required
The unique identifier of the message whose MIME content to retrieve. Must be obtained from message listing or query operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_ME_OUTLOOKTool to retrieve the outlookUser object for a specified user. Use when you need to access the Outlook services entity for a user.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the signed-in user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_MESSAGERetrieve a message by immutable ID from the specified Outlook mailbox. Use select to include fields such as internetMessageHeaders. A 404 can indicate a deleted message, a different mailbox, or a stale legacy mutable ID.

Input Parameters

array
List of message properties to include in the response. Can be provided as an array of strings (e.g., [‘subject’, ‘body’]) or as a comma-separated string (e.g., ‘subject,body’). Reduces data transfer and improves performance. Common fields: id, subject, from, toRecipients, ccRecipients, receivedDateTime, sentDateTime, body, bodyPreview, hasAttachments, webLink, internetMessageHeaders, isRead, importance, categories. Leave empty to return all message fields. Attachments are a separate Microsoft Graph navigation property; use OUTLOOK_LIST_OUTLOOK_ATTACHMENTS to retrieve them.
string
User’s email address, UPN, or ‘me’ for the currently authenticated user.
string
required
Unique immutable ID of the Outlook email message to retrieve. Accepts message IDs from OUTLOOK_LIST_MESSAGES (message.id), OUTLOOK_QUERY_EMAILS (message.id), or OUTLOOK_SEARCH_MESSAGES (use hitId from search results, as resource.id is not populated by the Search API). The message must exist in the specified user’s mailbox. Legacy mutable IDs can become stale after a folder move.
boolean
When true, retrieves and normalizes the message’s Microsoft Purview sensitivity label in the same Graph request. Requires Mail.Read or Mail.ReadWrite. Treat a returned status of unknown as fail-closed before using the message content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_MESSAGE_EXTENSIONRetrieve the identifying metadata of a specific extension on a user’s message.

Input Parameters

string
User ID, userPrincipalName, or ‘me’ for the authenticated user.
string
required
The unique identifier of the message containing the extension.
string
required
The unique identifier of the extension. Can be the extension name (e.g., ‘Com.Contoso.Test’) or the fully qualified name (e.g., ‘Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.Test’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_NESTED_FOLDER_MESSAGE_ATTACHMENTTool to retrieve a specific attachment from a message located in a nested mail folder structure. Use when you need to get attachment details from messages in deeply nested folders.

Input Parameters

string
required
The unique identifier of the user. Must be an actual user ID (e.g., ‘6640adbb5cb743b0’) or user principal name (UPN). Cannot use ‘me’ alias for this endpoint.
string
required
The unique identifier of the message containing the attachment.
string
required
The unique identifier of the attachment to retrieve.
string
required
The ID of the parent mail folder. Can be a well-known folder name (e.g., ‘inbox’, ‘drafts’, ‘sentitems’) or a folder ID obtained from listing mail folders.
array
required
List of child folder IDs representing the nested folder path. For a message in /folder1/subfolder1/subfolder2/, provide [‘subfolder1_id’, ‘subfolder2_id’]. Can be a single item for one level of nesting or multiple items for deeper nesting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_PLANNER_PLANRetrieve one Microsoft Planner plan by ID.

Input Parameters

string
required
Case-sensitive opaque ID of the Planner plan to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_PROFILERetrieves the Microsoft Outlook profile for a specified user.

Input Parameters

string
User profile properties to return. Pass a list (recommended) or a comma-separated string; both become one OData $select value. Omit or pass an empty value for Microsoft Graph’s default profile fields.
string
The user’s unique identifier or principal name. Use ‘me’ to get the profile of the authenticated user.
boolean
Whether to include proxy addresses in the response. Proxy addresses are SMTP addresses prefixed with ‘SMTP:’ (primary) or ‘smtp:’ (secondary).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_SCHEDULERetrieves free/busy schedule information for specified email addresses within a defined time window. Read-only; does not reserve time or prevent conflicts — verify availability before creating events.

Input Parameters

string
The user ID or principal name of the user whose calendar to query. Required for S2S (application) authentication. Can be either the GUID user ID (e.g., ‘43f0c14d-bca8-421f-b762-c3d8dd75be1f’) or the user principal name (e.g., ‘user@domain.com’). If not provided, the endpoint will use ‘/me’ which requires delegated authentication.
object
required
The end date, time, and time zone for the period for which to retrieve schedules. The period can be up to 62 days. Object must include dateTime (ISO 8601) and timeZone (valid Windows or IANA identifier). Must use same timezone convention as startTime.
array
required
A list of SMTP email addresses for users, distribution lists, or resources whose schedules are to be retrieved. Maximum of 20 addresses. Include all relevant participants; omitted addresses may cause slots to appear falsely free. External or invalid addresses may silently return no data.
object
required
The start date, time, and time zone for the period for which to retrieve schedules. Object must include dateTime (ISO 8601) and timeZone (valid Windows or IANA identifier, e.g., ‘UTC’, ‘Eastern Standard Time’). Invalid or naive timezone values cause HTTP 400 or silent DST-shifted windows.
string
The duration of each time slot in the availability view, specified in minutes. Minimum: 5, Maximum: 1440. Default: 30.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_SUPPORTED_LANGUAGESTool to retrieve supported languages in the user’s mailbox. Use when you need to display or select from available mailbox languages.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the signed-in user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_SUPPORTED_TIME_ZONESGet the time zones supported for a user as configured on their mailbox server, using delegated authentication. Use when setting up an Outlook client or configuring user time zone preferences.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the signed-in user.
string ("Windows" | "Iana")
Time zone format standard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_USER_BY_EMAILRetrieves user details from Microsoft Graph by email address (userPrincipalName). Returns user properties including display name, job title, department, and contact information. Use this action when you need to look up a user’s profile information using their email address.

Input Parameters

string
required
The email address (userPrincipalName) of the user to retrieve. This must be a valid email address format.
array
Optional list of user properties to include in the response. Reduces data transfer and improves performance. Common fields: id, displayName, givenName, surname, mail, userPrincipalName, jobTitle, officeLocation, mobilePhone, businessPhones, department. Leave empty to return default properties.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_USER_CALENDARRetrieves properties of a specific user’s calendar by calendar ID, with optional property selection.

Input Parameters

array
Properties to include in the response (OData $select). Specify which calendar fields you want returned to keep the response concise.
string
User ID or userPrincipalName. Use ‘me’ for the signed-in user.
string
required
The unique identifier of the calendar to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_USER_CALENDAR_ALLOWED_SHARING_ROLESTool to retrieve allowed calendar sharing roles for a specific user on a given calendar. Use when you need to determine what permission levels can be granted to a user for sharing a specific calendar.

Input Parameters

string
required
The email address or user principal name to check allowed calendar sharing roles for.
string
required
The user ID or User Principal Name of the calendar owner. Note: This endpoint does not support ‘me’ as a value; you must provide the explicit email address or user ID.
string
required
The unique identifier of the calendar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_USER_CALENDAR_EVENTTool to retrieve a specific calendar event from a user’s primary calendar. Use when you need detailed information about a particular event for a given user.

Input Parameters

string
required
The user’s primary SMTP address, user principal name (UPN), or user ID to identify the calendar owner whose event you want to retrieve.
string
required
The unique identifier of the calendar event to retrieve from the user’s calendar.
boolean
When true, retrieves and normalizes the event’s Microsoft Purview sensitivity label from a filtered msip_labels expansion in the same Graph request. This is distinct from the event’s built-in sensitivity field and from a Teams online meeting sensitivity-label assignment. Requires Calendars.Read or Calendars.ReadWrite. Treat a returned status of unknown as fail-closed before using the event content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_USER_CALENDAR_GROUP_CALENDAR_PERMISSIONTool to retrieve a specific calendar permission for a user’s calendar within a calendar group. Use when you need to check access permissions for a specific calendar.

Input Parameters

string
required
The unique identifier of the user. Cannot use ‘me’ shortcut - must be actual user ID or userPrincipalName.
string
required
The unique identifier of the calendar within the calendar group.
string
required
The unique identifier of the calendar permission to retrieve.
string
required
The unique identifier of the calendar group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_USER_CALENDAR_GROUP_EVENTTool to retrieve a specific event from a user’s calendar within a calendar group. Use when you need details of an event in a specific calendar group.

Input Parameters

string
The user ID or ‘me’ for the authenticated user.
string
required
The unique identifier of the event to retrieve.
string
required
The unique identifier of the calendar within the calendar group.
string
required
The unique identifier of the calendar group.
boolean
When true, retrieves and normalizes the event’s Microsoft Purview sensitivity label from a filtered msip_labels expansion in the same Graph request. This is distinct from the event’s built-in sensitivity field and from a Teams online meeting sensitivity-label assignment. Requires Calendars.Read or Calendars.ReadWrite. Treat a returned status of unknown as fail-closed before using the event content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_USER_CALENDAR_GROUP_EVENT_ATTACHMENTTool to retrieve a specific attachment from an event within a calendar group for a user. Use when you need to access attachment content from a calendar event in a user’s calendar group.

Input Parameters

string
The unique identifier of the user. Can use ‘me’ as shortcut for authenticated user.
string
required
The unique identifier of the event.
string
required
The unique identifier of the calendar within the calendar group.
string
required
The unique identifier of the attachment to retrieve.
string
required
The unique identifier of the calendar group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_USER_CHILD_FOLDER_MESSAGETool to retrieve a specific message from a child folder within a user’s mail folder hierarchy. Use when you need to access messages from nested folders where both parent and child folder IDs are known.

Input Parameters

array
List of message properties to include in the response. OData $select parameter. Valid properties include: id, subject, from, toRecipients, receivedDateTime, sentDateTime, hasAttachments, importance, isRead, body, bodyPreview, categories, conversationId, internetMessageHeaders. Leave empty to return all fields.
string
required
The unique identifier of the user. Must be an actual user ID (e.g., ‘6640adbb5cb743b0’) or user principal name (UPN). Cannot use ‘me’ alias for this endpoint.
string
required
The unique identifier of the message to retrieve from the child folder. Must be a valid message ID obtained from list or search operations.
string
required
The unique identifier of the parent mail folder. Must be a base64-encoded folder ID (e.g., ‘AAMkAGI0ZjExAAA=’) obtained from OUTLOOK_LIST_MAIL_FOLDERS or similar endpoints.
string
required
The unique identifier of the child folder within the parent mail folder. Must be a base64-encoded folder ID obtained from OUTLOOK_LIST_CHILD_MAIL_FOLDERS or similar endpoints.
boolean
When true, retrieves and normalizes the message’s Microsoft Purview sensitivity label in the same Graph request. Requires Mail.Read. Treat status unknown as fail-closed before using message content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_USER_EVENT_EXTENSIONTool to retrieve a specific open type extension from a user’s calendar event by its extension ID or name. Use when you need to access custom data stored in calendar event extensions.

Input Parameters

string
The user’s primary SMTP address, user principal name (UPN), or the alias ‘me’ (for the signed-in user) to identify the calendar owner.
string
required
The unique identifier of the calendar event.
string
required
The extension name or fully qualified name. Can be either the simple name (e.g., ‘Com.Contoso.Referral’) or fully qualified name (e.g., ‘Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.Referral’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_GET_USER_MESSAGES_ATTACHMENTSTool to retrieve a specific attachment from a message in a mail folder hierarchy. Use when you need to get attachment details including content from a specific folder path.

Input Parameters

string
required
The user’s email address, userPrincipalName, or user ID. Use ‘me’ for the authenticated user.
string
required
The unique identifier of the email message. Obtain from OUTLOOK_LIST_MESSAGES, OUTLOOK_QUERY_EMAILS, or OUTLOOK_SEARCH_MESSAGES.
string
required
The unique identifier of the attachment. Obtain from LIST_OUTLOOK_ATTACHMENTS action (use the ‘id’ field, NOT the ‘name’ field).
string
required
The ID of the parent mail folder. Can be a well-known folder name (‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, etc.) or a folder ID (base64-encoded string obtained from OUTLOOK_LIST_MAIL_FOLDERS).
string
The ID of the child folder within the parent mail folder. If provided, targets the message inside mailFolders/{id}/childFolders/{id}. If omitted, targets the message directly inside mailFolders/{id}. Must be a base64-encoded folder ID obtained from OUTLOOK_LIST_CHILD_MAIL_FOLDERS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_ASSIGNED_PLANNER_TASKSList Microsoft Planner tasks assigned to the signed-in user.

Input Parameters

string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_CALENDAR_CALENDAR_VIEWDEPRECATED: Use OUTLOOK_LIST_ME_CALENDARS_CALENDAR_VIEW instead. Tool to list calendar events within a specified date/time range. Use when you need to retrieve events from the user’s primary calendar that fall within a time window.

Input Parameters

integer
Maximum number of events to return per page (OData $top). Controls page size for pagination.
integer
Number of events to skip from the beginning of the result set (OData $skip). Use with $top for pagination.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
required
The end date and time of the time range, represented in ISO 8601 format. For example, ‘2019-11-08T20:00:00-08:00’ or ‘2024-12-31T23:59:59Z’.
string
required
The start date and time of the time range, represented in ISO 8601 format. For example, ‘2019-11-08T19:00:00-08:00’ or ‘2024-01-01T00:00:00Z’.
boolean
When true, retrieves and normalizes the Microsoft Purview sensitivity label applied to each calendar event. This is distinct from the event’s built-in sensitivity field and any Teams meeting label. Preserved in next_page_token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_CALENDAR_EVENT_ATTACHMENTSTool to list attachments for a calendar event within a specific calendar for a user. Use when you need to retrieve attachments from an event in a user’s specific calendar.

Input Parameters

integer
Maximum number of attachments to return (OData $top).
integer
Number of attachments to skip (OData $skip).
string
OData filter string to filter the attachments (OData $filter).
array
List of attachment properties to include (OData $select).
array
Order by clauses to sort the results (OData $orderby).
string
required
The unique identifier of the user. Must be a valid user ID (GUID) or userPrincipalName (UPN/email). Note: ‘me’ is NOT supported for this endpoint.
string
required
The unique identifier of the event.
string
required
The unique identifier of the calendar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_CALENDAR_GROUP_CALENDAR_EVENTSTool to list events from a specific calendar within a calendar group for a user. Use when you need to retrieve events from a user’s calendar that belongs to a specific calendar group.

Input Parameters

integer
Maximum number of events to retrieve per page for pagination.
integer
Number of initial events to bypass, used for pagination.
string
OData query string to filter calendar events. ONLY the following properties support filtering: ‘start/dateTime’, ‘end/dateTime’, ‘subject’, ‘categories’, ‘importance’, ‘sensitivity’, ‘isAllDay’, ‘isCancelled’, ‘isReminderOn’, ‘type’. CRITICAL: Properties like ‘body’, ‘bodyPreview’, ‘location’, ‘locations’, ‘organizer’, ‘attendees’ do NOT support $filter and will cause errors. IMPORTANT: Use calendar event properties ONLY. Do NOT use mail/message properties like ‘receivedDateTime’. For start/end filtering, you MUST use ‘start/dateTime’ and ‘end/dateTime’ ONLY. DO NOT use ‘start/date’ or ‘end/date’ - these properties do NOT exist and will cause errors. DateTime format: “start/dateTime ge ‘YYYY-MM-DDTHH:MM:SSZ’” (requires single quotes and timezone suffix). Operators: ge (>=), le (<=), eq (=), gt (>), lt (<). DateTime values without quotes or timezone suffix will be automatically normalized.
array
List of specific event property names to return. MUST be provided as a list. If omitted, a default set of properties is returned. Valid field names: id, subject, body, bodyPreview, start, end, isAllDay, organizer, attendees, location, locations, recurrence, importance, sensitivity, showAs, categories, hasAttachments, webLink, onlineMeeting, onlineMeetingProvider, onlineMeetingUrl, isOnlineMeeting, createdDateTime, lastModifiedDateTime, changeKey, iCalUId, type, seriesMasterId, isOrganizer, isReminderOn, reminderMinutesBeforeStart, responseRequested, responseStatus, allowNewTimeProposals, hideAttendees, isCancelled, isDraft, originalStart, originalStartTimeZone, originalEndTimeZone, transactionId, cancelledOccurrences. Note: ‘creator’ is NOT a valid field - use ‘organizer’ instead. Invalid field names will be automatically filtered out.
array
List of properties to sort results by. Each item is a string like ‘start/dateTime desc’ or ‘subject asc’. MUST be provided as a list, even for single sort criteria. Use ‘asc’ (default) or ‘desc’ for order. IMPORTANT: Use calendar event properties ONLY. Do NOT use mail/message properties like ‘receivedDateTime’. Valid sortable datetime fields: ‘start/dateTime’, ‘end/dateTime’, ‘createdDateTime’, ‘lastModifiedDateTime’.
string
required
The user’s primary SMTP address, user principal name (UPN), or user ID to identify the calendar owner.
string
Preferred timezone for event start/end times. Accepts IANA format (e.g., ‘America/New_York’, ‘Europe/London’, ‘Asia/Tokyo’) or Windows format (e.g., ‘Eastern Standard Time’, ‘Pacific Standard Time’). Falls back to ‘UTC’ if the timezone cannot be resolved.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
required
The unique identifier of the calendar within the calendar group.
string
required
The unique identifier of the calendar group containing the calendar.
boolean
When true, retrieves and normalizes the Microsoft Purview sensitivity label stored on each calendar event. This is distinct from the event’s built-in sensitivity field and from a Teams online meeting sensitivity label.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_CALENDAR_GROUP_CALENDARSTool to retrieve calendars belonging to a specific calendar group. Use when you need to list calendars within a calendar group with optional OData queries.

Input Parameters

integer
Maximum number of calendars to return (OData $top).
integer
Number of calendars to skip (OData $skip).
string
OData filter expression (OData $filter).
array
Properties to include (OData $select).
array
Order by expressions (OData $orderby).
string
User ID or userPrincipalName. Use ‘me’ for the signed-in user.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
required
The ID of the calendar group to retrieve calendars from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_CALENDAR_GROUP_EVENT_ATTACHMENTSTool to list attachments for a calendar event within a specific calendar group for a user. Use when you need to retrieve attachments from an event in a calendar that belongs to a calendar group for a specific user.

Input Parameters

integer
Maximum number of attachments to return (OData $top).
integer
Number of attachments to skip (OData $skip).
string
OData filter string to filter the attachments (OData $filter).
array
List of attachment properties to include (OData $select).
array
Order by clauses to sort the results (OData $orderby).
string
The unique identifier of the user. Can use ‘me’ as shortcut for authenticated user.
string
required
The unique identifier of the event.
string
required
The unique identifier of the calendar within the calendar group.
string
required
The unique identifier of the calendar group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_CALENDAR_GROUPSList calendar groups in the signed-in user’s or a specified user’s mailbox, with optional OData queries.

Input Parameters

integer
Maximum number of calendar groups to return (OData $top).
integer
Number of calendar groups to skip (OData $skip).
string
OData filter expression (OData $filter).
array
Properties to include (OData $select).
array
Order by expressions (OData $orderby).
string
User ID or userPrincipalName. Use ‘me’ for the signed-in user.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_CALENDAR_PERMISSIONSTool to list calendar permissions for a specific calendar within a calendar group. Use when you need to view sharing permissions for a calendar.

Input Parameters

integer
Maximum number of permissions to return per page (OData $top).
integer
Number of items to skip for pagination (OData $skip).
string
The unique identifier of the user. Can use ‘me’ for the authenticated user.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
required
The unique identifier of the calendar within the calendar group.
string
required
The unique identifier of the calendar group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_CALENDARSList calendars in the signed-in user’s or a specified user’s mailbox, with optional OData queries.

Input Parameters

integer
Maximum number of calendars to return (OData $top).
integer
Number of calendars to skip (OData $skip).
string
OData filter expression (OData $filter).
array
Properties to include (OData $select).
array
Order by expressions (OData $orderby).
string
User ID or userPrincipalName. Use ‘me’ for the signed-in user.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_CALENDAR_VIEW_DELTARetrieve calendar-view delta events for a specified time range, including changes since a prior sync. Deleted entries do not retain their removal marker in the response.

Input Parameters

string
The user ID (GUID format like ‘43f0c14d-bca8-421f-b762-c3d8dd75be1f’) or user principal name (email format like ‘user@domain.com’) of the mailbox to access. Required for app-only (S2S) authentication with application permissions. If not provided, uses ‘/me’ endpoint which requires delegated permissions.
string
A state token returned in the @odata.nextLink URL of the previous delta function call. Accepts either the full @odata.nextLink URL or just the bare token value. Use this to page through large result sets during initial sync or updates. Keep paginating until you receive ‘@odata.deltaLink’ instead of nextLink. When using Purview sensitivity-label enrichment, resend include_sensitivity_label=true with this token.
string
A state token returned in the @odata.deltaLink URL of the previous delta function call. Accepts either the full @odata.deltaLink URL or just the bare token value. Use this to get only changes since the last sync. On first call, omit this parameter to get all events in the time range. Store the @odata.deltaLink from the response for subsequent calls. When using Purview sensitivity-label enrichment, resend include_sensitivity_label=true with this token.
string
The end date and time of the time range, represented in ISO 8601 format. For example, ‘2015-11-08T20:00:00.0000000’ or ‘2015-11-08T20:00:00Z’. This parameter is required for the first delta query to establish the time window.
string
The start date and time of the time range, represented in ISO 8601 format. For example, ‘2015-11-08T19:00:00.0000000’ or ‘2015-11-08T19:00:00Z’. This parameter is required for the first delta query to establish the time window.
boolean
When true, hydrates each non-deleted event’s Microsoft Purview sensitivity label through Graph JSON batches capped at 20 requests per batch. Delta does not support the required $expand. This is distinct from the event’s built-in sensitivity field and from a Teams online meeting sensitivity-label assignment. Deleted events and failed lookups have status unknown; treat unknown as fail-closed. Repeat this flag on every call that uses skiptoken or deltatoken because Graph tokens do not preserve this Composio-only setting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_CHAT_MESSAGESTool to list messages in a Teams chat. Use when you need message IDs to select a specific message for further actions.

Input Parameters

integer
Number of messages per page (max 50).
string
OData filter expression for date/time filtering; honored when matching orderby property.
string
required
ID of the chat to retrieve messages from.
string
Order by property; supports ‘lastModifiedDateTime desc’ or ‘createdDateTime desc’.
string
Pagination token from the @odata.nextLink of a previous response. Pass the $skiptoken value (not the full URL) to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_CHATSTool to list Teams chats. Use when you need chat IDs and topics to select a chat for further actions.

Input Parameters

integer
Number of chat items per page (max 50).
string
Related entities to expand: ‘members’ or ‘lastMessagePreview’.
string
OData filter expression to filter chats, such as by topic.
string
Properties to order by; only ‘lastMessagePreview/createdDateTime desc’ is supported (ascending order not supported).
string
User ID (GUID or email) to list chats for. Required for S2S (app-only) authentication. If not provided, uses ‘/me’ endpoint (requires delegated authentication).
string
Pagination token from the @odata.nextLink of a previous response. Pass the $skiptoken value (not the full URL) to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_CHILD_FOLDER_CONTACTSTool to retrieve contacts from a user’s child contact folder. Use when you need to access contacts organized in nested folder structures for a specific user.

Input Parameters

integer
Maximum number of contacts to retrieve per page (1-999).
integer
Number of contacts to skip from the beginning of the result set, for pagination. Use with ‘top’ to iterate through large contact lists.
string
OData V4 filter expression for targeted retrieval.
array
List of specific contact properties to retrieve. Valid Contact properties: displayName, givenName, surname, middleName, nickName, title, generation, emailAddresses, imAddresses, jobTitle, companyName, department, officeLocation, profession, businessHomePage, assistantName, manager, homePhones, mobilePhone, businessPhones, spouseName, personalNotes, children, homeAddress, businessAddress, otherAddress, categories, birthday, fileAs, initials, yomiGivenName, yomiSurname, yomiCompanyName, parentFolderId, changeKey, createdDateTime, lastModifiedDateTime.
array
List of properties to sort results by. Each item is a string like ‘displayName asc’ or ‘createdDateTime desc’. MUST be provided as a list, even for single sort criteria. ‘asc’ is default.
string
required
The unique identifier of the user (email address or user ID). Use email format (e.g., ‘user@example.com’) or Azure AD user ID.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
required
The ID of the child folder to retrieve contacts from. Required.
string
required
The ID of the parent contact folder containing the child folder. Required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_CHILD_FOLDER_MESSAGESTool to list messages from a child folder within a parent mail folder. Use when you need to retrieve messages from a subfolder that exists within another folder.

Input Parameters

integer
Maximum number of messages to return per request (1-1000). To page through more, use the next_page_token from the response (pass it back as page_token).
integer
Number of messages to skip from the beginning of the result set, for pagination.
string
OData $filter query to filter messages. Examples: ‘isRead eq false’, ‘from/emailAddress/address eq ‘sender@example.com”, ‘receivedDateTime ge 2023-01-01T00:00:00Z’, ‘hasAttachments eq true’. Note: Combining complex filters (especially on nested properties like ‘from/emailAddress/address’) with the ‘orderby’ parameter may fail with an InefficientFilter error. In such cases, remove ‘orderby’ or apply sorting client-side.
array
List of message properties to include in the response. OData $select parameter. Valid properties include: id, subject, from, toRecipients, receivedDateTime, sentDateTime, hasAttachments, importance, isRead, body, bodyPreview, categories, conversationId.
string
Property to sort results by with direction. OData $orderby parameter. Example: ‘receivedDateTime desc’ or ‘subject asc’. Note: Using ‘orderby’ together with complex ‘filter’ queries (especially on nested properties like ‘from/emailAddress/address’) may fail with an InefficientFilter error. If this occurs, either remove ‘orderby’ or apply sorting client-side.
string
User’s id, userPrincipalName, or ‘me’ for the signed-in user.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
required
The ID or well-known name of the parent mail folder. ONLY these specific well-known names are valid as string names: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. Arbitrary folder names (e.g., ‘workjournal’) are NOT valid. If the folder is not one of these well-known names, you MUST use the actual folder ID - a base64-encoded string (e.g., ‘AAMkAGI0ZjExAAA=’) obtained from OUTLOOK_LIST_MAIL_FOLDERS.
string
required
The ID of the child folder within the parent mail folder from which to retrieve messages. This must be a base64-encoded folder ID (e.g., ‘AAMkAGI0ZjExAAA=’) obtained from OUTLOOK_LIST_CHILD_MAIL_FOLDERS. Well-known names are NOT valid for child folders.
boolean
When true, retrieves and normalizes Microsoft Purview sensitivity labels in the same Graph request. Requires Mail.Read. Treat status unknown as fail-closed. Preserved in next_page_token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_CHILD_MAIL_FOLDERSList a mail folder’s immediate child folders, with property projection and paging controls. Use this to navigate and inspect a nested mailbox folder hierarchy.

Input Parameters

integer
Maximum number of child folders to return. OData $top parameter.
integer
Number of child folders to skip from the beginning of the result set (OData $skip). Use with $top for pagination.
string
OData $filter query to filter the child folders. Example: ‘isHidden eq false’.
string
MailFolder properties to include in the response. Pass a list (recommended) or a comma-separated string; both become one OData $select value. Valid properties include: id, displayName, parentFolderId, childFolderCount, unreadItemCount, totalItemCount, isHidden.
string
User’s id, userPrincipalName, or ‘me’ for the signed-in user.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
required
The ID or well-known name of the parent mail folder. Common well-known names include: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. For folder IDs, obtain them from OUTLOOK_LIST_MAIL_FOLDERS or previous childFolders responses. Folder IDs are base64-encoded strings (e.g., ‘AAMkAGI0ZjExAAA=’) that are mailbox-specific and must come from the same user’s mailbox. No URL encoding needed - it’s handled automatically.
boolean
Include hidden mail folders (isHidden=true) when set to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_CONTACT_FOLDER_CHILD_FOLDERSTool to list child folders under a specified contact folder. Use when navigating nested contact folder hierarchies or organizing contacts into subfolder structures.

Input Parameters

integer
Maximum number of child folders to return. OData $top parameter.
integer
Number of child folders to skip for pagination. OData $skip parameter.
array
Related entities to expand inline. OData $expand parameter. Example: [‘contacts’].
string
OData $filter query to filter the child folders. Example: startswith(displayName,‘A’).
array
List of contactFolder properties to include in the response. OData $select parameter. Valid properties include: id, displayName, parentFolderId.
array
List of properties to order results by. OData $orderby parameter. Example: [‘displayName asc’].
string
User’s id, userPrincipalName, or ‘me’ for the signed-in user.
string
required
The ID of the parent contact folder. Obtain folder IDs from OUTLOOK_GET_CONTACT_FOLDERS or previous childFolders responses. Folder IDs are base64-encoded strings that are mailbox-specific and must come from the same user’s mailbox.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_CONTACT_FOLDERS_DELTATool to get contact folders that have been added, deleted, or updated. Use when tracking changes to contact folder structure without fetching all folders each time.

Input Parameters

string
Comma-separated list of properties to include in the response. The id property is always returned. Available properties: id, displayName, parentFolderId.
string
The ID (user principal name or GUID) of the user. Required for app-only (S2S) authentication. If not provided, uses ‘/me’ endpoint (requires delegated authentication). Accepts both email format (user@domain.com) and GUID format.
string
A state token returned in the @odata.nextLink URL of the previous delta function call. Accepts either the full @odata.nextLink URL or just the bare token value. Use this to page through large result sets during initial sync or updates. Keep paginating until you receive ‘@odata.deltaLink’ instead of nextLink.
string
A state token returned in the @odata.deltaLink URL of the previous delta function call. Accepts either the full @odata.deltaLink URL or just the bare token value. Use this to get only changes since the last sync. On first call, omit this parameter to get all contact folders. Store the @odata.deltaLink from the response for subsequent calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_CONTACTSDEPRECATED: Use OUTLOOK_LIST_USER_CONTACTS instead. Retrieves a user’s Microsoft Outlook contacts, from the default or a specified contact folder.

Input Parameters

integer
Maximum number of contacts to retrieve per page (1-999).
integer
Number of contacts to skip from the beginning of the result set, for pagination. Use with ‘top’ to iterate through large contact lists.
string
OData V4 filter expression for targeted retrieval.
array
List of specific contact properties to retrieve. Valid Contact properties: displayName, givenName, surname, middleName, nickName, title, generation, emailAddresses (not ‘mail’ - that’s for User type), imAddresses, jobTitle, companyName, department, officeLocation, profession, businessHomePage, assistantName, manager, homePhones, mobilePhone, businessPhones, spouseName, personalNotes, children, homeAddress, businessAddress, otherAddress, categories, birthday, fileAs, initials, yomiGivenName, yomiSurname, yomiCompanyName, parentFolderId, changeKey, createdDateTime, lastModifiedDateTime.
array
List of properties to sort results by. Each item is a string like ‘displayName asc’ or ‘createdDateTime desc’. MUST be provided as a list, even for single sort criteria. ‘asc’ is default.
string
User Principal Name (UPN) or ID of the user. ‘me’ refers to the authenticated user.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
ID of a specific contact folder. If omitted, contacts are retrieved from the default contact folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_CONTACTS_DELTARetrieve incremental changes to contacts in a specified folder for synchronization. The initial sync may require paging before a delta link is returned; use the stored delta link for subsequent changes.

Input Parameters

array
List of contact properties to include (e.g. [‘displayName’,‘emailAddresses’]). Available properties: id, displayName, givenName, surname, middleName, nickName, title, generation, emailAddresses, imAddresses, jobTitle, companyName, department, officeLocation, profession, businessHomePage, assistantName, manager, homePhones, mobilePhone, businessPhones, spouseName, personalNotes, children, homeAddress, businessAddress, otherAddress, categories, birthday, fileAs, initials, yomiGivenName, yomiSurname, yomiCompanyName, parentFolderId, changeKey, createdDateTime, lastModifiedDateTime.
string
User ID (GUID) or user principal name (email) for app-only (S2S) authentication. Required when using client credentials flow. If not provided, uses ‘/me’ endpoint (delegated auth). Example: ‘43f0c14d-bca8-421f-b762-c3d8dd75be1f’ or ‘user@example.com’
string
Skip token for paging through large result sets during initial sync. Accepts either the full @odata.nextLink URL or just the bare token value. Keep paginating until you receive ‘@odata.deltaLink’ instead of nextLink. Mutually exclusive with delta_token - only one should be provided per request.
string
Delta token from a previous call to get only changes since that state. Accepts either the full @odata.deltaLink URL or just the bare token value. If omitted or invalid (placeholders like <token> are ignored), performs initial sync. Response includes @odata.deltaLink - store this for subsequent calls. Mutually exclusive with skip_token - only one should be provided per request.
string
required
Contact folder identifier (folder GUID). Use GET_CONTACT_FOLDERS action to retrieve available folder IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_DIRECT_GROUP_MEMBERSHIPSList Microsoft Entra groups the signed-in user directly belongs to.

Input Parameters

integer
Maximum number of groups requested on this page (OData $top).
string
OData $filter expression used to restrict returned groups.
string
OData $search expression for group display names, such as ‘“displayName:Engineering”’.
string
Group properties to return as a list or comma-separated string (OData $select).
string
OData $orderby expression used to order returned groups.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified. Do not construct or edit it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_EMAIL_RULESList inbox email rules for the authenticated or specified user. Results may include rule conditions, actions, sequence, and stop-processing settings; use top and skip to page through rules, and narrow results client-side.

Input Parameters

integer
Number of rules to retrieve. Default is 100. Setting this too low may return an incomplete rule set; use 100 or higher to ensure all rules are retrieved.
integer
Number of rules to skip before returning results. Use with ‘top’ for offset-based pagination.
string
The user ID or principal name (email) to list email rules for. Required for S2S (app-only) authentication. If not provided, uses the authenticated user context (/me).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_EVENT_ATTACHMENTSTool to list attachments for a specific Outlook calendar event. Use when you have an event ID and need to view its attachments.

Input Parameters

integer
Maximum number of attachments to return (OData $top).
integer
Number of attachments to skip (OData $skip).
string
OData filter string to filter the attachments (OData $filter).
array
List of attachment properties to include (OData $select).
array
Order by clauses to sort the results (OData $orderby).
string
The user’s primary SMTP address, UPN, or ‘me’ for the signed-in user.
string
required
The unique identifier of the calendar event to retrieve attachments for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_EVENT_CALENDAR_CALENDAR_PERMISSIONSTool to list calendar permissions for the calendar containing a specific event. Use when you need to see who has access to a calendar that contains a particular event.

Input Parameters

integer
Maximum number of permissions to return (OData $top parameter).
integer
Number of permissions to skip (OData $skip parameter).
string
OData filter expression to filter permissions (OData $filter parameter).
array
Properties to include in the response (OData $select parameter).
array
Order by expressions (OData $orderby parameter).
string
The user’s primary SMTP address, user principal name (UPN), or the alias ‘me’ (for the signed-in user) to identify the calendar owner.
string
required
The unique identifier of the calendar event.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_EVENT_INSTANCESTool to retrieve individual occurrences of a recurring calendar event within a specified time range. Use when you need to get specific instances of a recurring meeting or event series.

Input Parameters

integer
Maximum number of event instances to return per page (OData $top). Controls page size for pagination.
integer
Skip the first n items
boolean
Include count of items
array
Expand related entities
string
Filter items by property values
string
Search items by search phrases
array
Select properties to be returned
array
Order items by property values
string
Email address of the target user (or ‘me’ for authenticated user), identifying the calendar owner.
string
required
The unique identifier of the recurring event (seriesMaster) for which to retrieve instances.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
required
The end date and time of the time range in ISO 8601 format (e.g., 2026-04-30T23:59:59.0000000). Only instances that start within or overlap this range will be returned.
string
required
The start date and time of the time range in ISO 8601 format (e.g., 2026-03-01T00:00:00.0000000). Only instances that start within or overlap this range will be returned.
boolean
When true, retrieves and normalizes Microsoft Purview sensitivity labels in the same Graph request. Requires Calendars.Read. Treat status unknown as fail-closed. Preserved in next_page_token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_EVENTSRetrieves events from a user’s Outlook calendar via Microsoft Graph API. Supports primary/secondary/shared calendars, pagination, filtering, property selection, sorting, and timezone specification. Use calendar_id to access non-primary calendars.

Input Parameters

integer
Maximum number of events to retrieve per page for pagination.
integer
Number of initial events to bypass, used for pagination.
string
OData query string to filter calendar events. Filterable properties: ‘start/dateTime’, ‘end/dateTime’, ‘subject’, ‘categories’, ‘importance’, ‘sensitivity’, ‘isAllDay’, ‘isCancelled’, ‘isReminderOn’, ‘type’. CRITICAL: Properties like ‘body’, ‘bodyPreview’, ‘location’, ‘organizer’, ‘attendees’ do NOT support $filter. Do NOT use mail properties like ‘receivedDateTime’ (emails only). For start/end filtering, use ‘start/dateTime’ and ‘end/dateTime’ ONLY - do NOT use ‘start/date’ or ‘end/date’ (these do not exist). Works for both all-day and timed events. Note: ‘createdDateTime’ and ‘lastModifiedDateTime’ only support $orderby/$select, NOT filtering. DateTime format: “start/dateTime ge ‘YYYY-MM-DDTHH:MM:SSZ’” (requires single quotes and timezone suffix). Operators: ge (>=), le (<=), eq (=), gt (>), lt (<).
array
List of specific event property names to return. MUST be provided as a list. If omitted, a default set of properties is returned. Valid field names: id, subject, body, bodyPreview, start, end, isAllDay, organizer, attendees, location, locations, recurrence, importance, sensitivity, showAs, categories, hasAttachments, webLink, onlineMeeting, onlineMeetingProvider, onlineMeetingUrl, isOnlineMeeting, createdDateTime, lastModifiedDateTime, changeKey, iCalUId, type, seriesMasterId, isOrganizer, isReminderOn, reminderMinutesBeforeStart, responseRequested, responseStatus, allowNewTimeProposals, hideAttendees, isCancelled, isDraft, originalStart, originalStartTimeZone, originalEndTimeZone, transactionId, cancelledOccurrences. Note: ‘creator’ is NOT a valid field - use ‘organizer’ instead to get the event creator/organizer. Invalid field names will be automatically filtered out.
array
List of properties to sort results by. Each item is a string like ‘start/dateTime desc’ or ‘subject asc’. MUST be provided as a list, even for single sort criteria. Use ‘asc’ (default) or ‘desc’ for order. IMPORTANT: Use calendar event properties ONLY. Do NOT use mail/message properties like ‘receivedDateTime’ (which is for emails only). Valid sortable datetime fields: ‘start/dateTime’, ‘end/dateTime’, ‘createdDateTime’, ‘lastModifiedDateTime’. Invalid mail properties will be auto-corrected to ‘start/dateTime’.
string
Email address of the target user (or ‘me’ for authenticated user), identifying the calendar for event listing.
string
Preferred timezone for event start/end times. Accepts IANA format (e.g., ‘America/New_York’, ‘Europe/London’, ‘Indian/Mauritius’, ‘Asia/Tokyo’) or Windows format (e.g., ‘Eastern Standard Time’, ‘Pacific Standard Time’). Placeholder patterns like ‘<REGION>/London’ are auto-resolved to valid IANA timezones (e.g., ‘Europe/London’) where the city can be matched. Falls back to ‘UTC’ only if the timezone cannot be resolved.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them. Not available together with expand_recurring_events.
string
Optional ID of a specific calendar to retrieve events from. If not provided, uses the default calendar. Get calendar IDs using LIST_CALENDARS action. IMPORTANT: Do NOT use ‘primary’ or ‘default’ as values - these are not valid calendar IDs in Microsoft Graph. Leave this field empty/null to access the default calendar. Useful for accessing secondary calendars, shared calendars, or team calendars.
boolean
When true, automatically expands recurring events to show actual occurrences within the filtered date range instead of series masters. When false (default), returns series masters as before.
boolean
When true, retrieves and normalizes the Microsoft Purview sensitivity label stored on each calendar event. This is distinct from the event’s built-in sensitivity field and from a Teams online meeting sensitivity label.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_GROUP_CALENDAR_VIEWList occurrences, exceptions, and single events from a Microsoft 365 group’s default calendar in a time window.

Input Parameters

integer
Maximum number of events to return on this page (OData $top).
string
Event properties to return as a list or comma-separated string (OData $select).
string
Opaque Microsoft 365 group ID. Required for the first page; omit when page_token is set.
string
Opaque continuation token returned as next_page_token. Pass it back unchanged to retrieve the next page.
string
Exclusive end of the calendar view in ISO 8601 format. Required for the first page; omit when page_token is set.
string
Inclusive start of the calendar view in ISO 8601 format. Required for the first page; omit when page_token is set.
string ("text" | "html")
Format for returned event bodies, sent as Prefer: outlook.body-content-type.
string
Windows time-zone name for returned event start and end values, sent as Prefer: outlook.timezone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_GROUP_CONVERSATIONSList conversation summaries in a Microsoft 365 group.

Input Parameters

string
OData $filter expression for conversation properties supported by Microsoft Graph.
string
Conversation properties to return. Pass a list or a comma-separated string; both become one OData $select value.
string
required
The unique identifier of the Microsoft 365 group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_GROUP_CONVERSATION_THREADSList threads contained in one Microsoft 365 group conversation.

Input Parameters

string
Comma-separated conversation-thread fields to return (OData $select).
string
required
Opaque ID of the Microsoft 365 group.
string
required
Opaque ID of the group conversation whose threads to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_GROUP_THREAD_POSTSList posts in one Microsoft 365 group conversation thread.

Input Parameters

integer
Maximum number of posts requested (OData $top).
string
One post relationship to expand (OData $expand).
string
Post properties to return as a list or comma-separated string (OData $select).
string
required
Microsoft 365 group ID containing the conversation thread.
string
required
Conversation thread ID whose posts to list.
string
Opaque continuation token for the next page. Omit for the first page; then pass back next_page_token unmodified. Do not construct or edit it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_GROUP_THREADSList conversation threads in a Microsoft 365 group with OData controls.

Input Parameters

integer
Maximum number of threads to return (OData $top).
integer
Number of threads to skip (OData $skip).
string
OData filter expression used to restrict returned threads.
string
Thread fields to return as a list or comma-separated string (OData $select).
string
OData ordering expression, such as ‘lastDeliveredDateTime desc’.
string
required
Microsoft 365 group ID whose conversation threads to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_INFERENCE_CLASSIFICATION_OVERRIDESTool to list inference classification overrides that control Focused Inbox sender rules. Use when you need to see which senders are configured to always appear in Focused or Other inbox.

Input Parameters

integer
Maximum number of overrides to return per page (OData $top).
integer
Number of items to skip for pagination (OData $skip).
string
The user’s unique identifier or ‘me’ for the authenticated user. Use ‘me’ to get overrides for your own mailbox, or specify a user ID/email for delegated access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_LICENSE_DETAILSList the authenticated user’s assigned Microsoft product licenses and service plans.

Input Parameters

string
License detail properties to return. Pass a list or comma-separated string; both are sent as one OData $select value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_MAIL_FOLDER_MESSAGE_ATTACHMENTSTool to get attachments from a message in a specific mail folder. Use when you need to retrieve attachment metadata from a message located in a particular folder.

Input Parameters

integer
Maximum number of attachments to return per page (OData $top).
integer
Number of items to skip for pagination (OData $skip).
string
The user ID or principal name (email) of the user mailbox to access. Required for app-only (S2S) authentication. Use ‘me’ or omit for delegated authentication. Example: ‘43f0c14d-bca8-421f-b762-c3d8dd75be1f’ or ‘user@domain.com’
string
required
The unique identifier of the email message from which to retrieve attachments. Must be a message ID obtained from OUTLOOK_LIST_MESSAGES or OUTLOOK_SEARCH_EMAILS.
string
required
The ID or well-known name of the mail folder containing the message. ONLY these specific well-known names are valid as string names: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. Arbitrary folder names (e.g., ‘workjournal’) are NOT valid. If the folder is not one of these well-known names, you MUST use the actual folder ID - a base64-encoded string (e.g., ‘AAMkAGI0ZjExAAA=’) obtained from OUTLOOK_LIST_MAIL_FOLDERS or OUTLOOK_LIST_CHILD_MAIL_FOLDERS.
string ("minimal" | "full")
Level of detail in the response. ‘minimal’ (default) returns only attachment metadata (id, name, size, contentType, etc.) for efficient listing. ‘full’ includes the base64-encoded file content (contentBytes) for downloading.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_MAIL_FOLDER_MESSAGE_RULESTool to list message rules for a specific mail folder. Use when you need to retrieve rules configured for a particular folder.

Input Parameters

integer
Maximum number of message rules to return. Default is all rules if not specified.
integer
Number of rules to skip before returning results. Use with ‘top’ for offset-based pagination.
string
User’s id, userPrincipalName, or ‘me’ for the signed-in user.
string
required
The ID or well-known name of the mail folder from which to retrieve message rules. ONLY these specific well-known names are valid as string names: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. Arbitrary folder names are NOT valid. If the folder is not one of these well-known names, you MUST use the actual folder ID - a base64-encoded string obtained from OUTLOOK_LIST_MAIL_FOLDERS or OUTLOOK_LIST_CHILD_MAIL_FOLDERS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_MAIL_FOLDER_MESSAGESCompatibility action that lists messages directly contained in one specified mail folder. It does not recursively include messages from descendant folders. Prefer OUTLOOK_LIST_MESSAGES for new calls; use this action only when its $expand support is required.

Input Parameters

integer
Maximum number of messages to return per request (1-1000). To page through more, use the next_page_token from the response (pass it back as page_token).
integer
Number of messages to skip from the beginning of the result set, for pagination.
array
List of message navigation properties to include inline using OData $expand. Use Graph expansion expressions such as ‘attachments’ or ‘attachments($select=id,name,size,contentType,isInline)’. Regular message properties belong in select, not expand.
string
OData $filter query to filter messages. CRITICAL: String literals MUST use single quotes (’), not double quotes (”). Examples: ‘isRead eq false’, ‘from/emailAddress/address eq ‘sender@example.com”, ‘receivedDateTime ge 2023-01-01T00:00:00Z’, ‘hasAttachments eq true’. IMPORTANT: Complex filters (multiple ‘contains()’ operations, OR clauses, or nested properties like ‘from/emailAddress/address’) CANNOT be combined with ‘orderby’ - Microsoft Graph will reject such requests with InefficientFilter error. When using complex filters, you MUST either: (1) omit ‘orderby’ and sort results client-side, or (2) simplify the filter to basic equality/comparison operations.
array
List of message properties to include in the response. OData $select parameter. Valid properties include: id, subject, from, toRecipients, receivedDateTime, sentDateTime, hasAttachments, importance, isRead, body, bodyPreview, categories, conversationId.
string
Property to sort results by with direction. OData $orderby parameter. Example: ‘receivedDateTime desc’ or ‘subject asc’. IMPORTANT: Cannot be used with complex ‘filter’ queries (multiple ‘contains()’ operations, OR clauses, or nested properties like ‘from/emailAddress/address’) - Microsoft Graph will reject such combinations with InefficientFilter error. For complex filters, omit this parameter and sort results client-side.
string
User’s id, userPrincipalName, or ‘me’ for the signed-in user.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
required
The ID or well-known name of the mail folder from which to retrieve messages. ONLY these specific well-known names are valid as string names: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. Arbitrary folder names (e.g., ‘workjournal’) are NOT valid. If the folder is not one of these well-known names, you MUST use the actual folder ID - a base64-encoded string (e.g., ‘AAMkAGI0ZjExAAA=’) obtained from OUTLOOK_LIST_MAIL_FOLDERS or OUTLOOK_LIST_CHILD_MAIL_FOLDERS.
boolean
When true, retrieves and normalizes Microsoft Purview sensitivity labels in the same Graph request. Requires Mail.Read. Treat status unknown as fail-closed. Preserved in next_page_token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_MAIL_FOLDERSList a user’s top-level Outlook mail folders with property projection, hidden-folder control, and paging. Use this to inspect the mailbox folder inventory or obtain folder IDs.

Input Parameters

integer
Maximum number of items to return per page.
integer
Number of items to skip before returning results.
boolean
Include total count of matching items in the response.
string
OData filter expression to filter mail folders. String values must be enclosed in single quotes (e.g., displayName eq ‘Inbox’). WARNING: Microsoft Graph API does not officially document which mailFolder properties support filtering. Known unsupported properties: parentFolderId (causes ErrorInvalidProperty error). To filter by parent folder, use the child folders endpoint instead: GET /me/mailFolders/{parentFolderId}/childFolders. Properties like isHidden may work but are not guaranteed.
string
MailFolder properties to include in the response. Pass a list (recommended) or a comma-separated string; both become one OData $select value. Valid properties: id, displayName, parentFolderId, childFolderCount, unreadItemCount, totalItemCount, isHidden.
string
Property to sort by, optionally followed by ‘asc’ or ‘desc’.
string
User’s id, userPrincipalName, or ‘me’ for the signed-in user.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
boolean
Include hidden mail folders (isHidden=true) when set to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_MAIL_FOLDERS_DELTARetrieve incremental mail-folder changes for a mailbox using delta or continuation tokens. Deleted folder entries do not retain their deletion marker in the response.

Input Parameters

string
OData query parameter to specify only the properties needed for best performance. Comma-separated list of properties (e.g., ‘id,displayName,parentFolderId’). The ‘id’ property is always returned.
string
Identifier for the user whose mailbox changes to track. Use ‘me’ for the authenticated user or provide the user’s principal name or ID.
string
A state token returned in the @odata.nextLink URL of the previous delta function call, indicating there are further changes to be tracked in the same round.
string
A state token returned in the @odata.deltaLink URL of the previous delta function call, indicating the completion of that round of change tracking. Include this to get changes since the last complete sync.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_MASTER_CATEGORIESDeprecated: Use OUTLOOK_GET_MASTER_CATEGORIES instead, which adds pagination (top/skip), filtering, field selection, and sorting.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the signed-in user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_ME_CALENDAR_PERMISSIONSList sharing permissions and permission levels for a specific user’s default calendar.

Input Parameters

integer
Maximum number of permissions to return (OData $top parameter).
integer
Number of permissions to skip (OData $skip parameter).
string
required
User ID or userPrincipalName of the user whose calendar permissions to list.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_ME_EVENT_INSTANCESDEPRECATED: Use OUTLOOK_LIST_EVENT_INSTANCES instead. Tool to retrieve individual occurrences of a recurring calendar event within a specified time range. Use when you need to get specific instances of a recurring meeting or event series from the authenticated user’s primary calendar.

Input Parameters

integer
Maximum number of event instances to return per page (OData $top). Controls page size for pagination.
integer
Number of event instances to skip from the beginning of the result set (OData $skip). Use with $top for pagination.
string
required
The unique identifier of the recurring event (seriesMaster) for which to retrieve instances.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
required
The end date and time of the time range in ISO 8601 format (e.g., 2026-05-01T00:00:00Z). Only instances that start within or overlap this range will be returned.
string
required
The start date and time of the time range in ISO 8601 format (e.g., 2026-03-01T00:00:00Z). Only instances that start within or overlap this range will be returned.
boolean
When true, retrieves and normalizes Microsoft Purview sensitivity labels in the same Graph request. Requires Calendars.Read. Treat status unknown as fail-closed. Preserved in next_page_token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_MESSAGE_ATTACHMENTS_FROM_CHILD_FOLDERTool to list attachments from a message in a nested child mail folder. Use when you need to retrieve attachment metadata from a message located in a subfolder.

Input Parameters

integer
Optional OData $top limit on the number of attachments to return. This endpoint returns the full attachment collection in a single response (no continuation cursor), so this is only an explicit cap.
string
OData $filter query to filter attachments. Examples: ‘size gt 1000000’, ‘isInline eq false’, ‘contentType eq “application/pdf”’.
string
Comma-separated list of attachment properties to include. Valid properties: id, name, contentType, size, isInline, lastModifiedDateTime. Example: ‘id,name,size’.
string
User’s id, userPrincipalName, or ‘me’ for the signed-in user.
string
required
The unique identifier of the email message from which to retrieve attachments. Must be a message ID obtained from list or search operations, not a folder ID.
string
required
The ID or well-known name of the parent mail folder. Valid well-known names: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. For custom folders, use the base64-encoded folder ID from OUTLOOK_LIST_MAIL_FOLDERS.
string
required
The ID of the child folder containing the message. Must be a valid folder ID (base64-encoded string) obtained from OUTLOOK_LIST_CHILD_MAIL_FOLDERS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_MESSAGESList or query Outlook messages in one folder (Inbox by default) or across the mailbox, with filters, search, field selection, sorting, and pagination. Some filters apply after each page is fetched, so empty pages can precede further results; search drops server-side filters, sorting, and offset.

Input Parameters

integer
Maximum number of messages to return per request (1-1000). To page through more, use the next_page_token from the response (pass it back as page_token), repeating until it is absent. For large mailboxes (1000+ messages), always paginate.
integer
Number of messages to skip from the beginning of the result set, for pagination.
string
Raw OData $filter expression for server-side message filtering, for example “sentDateTime ge 2026-01-01T00:00:00Z”. Use this for sentDateTime ge/le and conditions not covered by the simple filter parameters. If both are provided, this expression and the simple filters are combined with ‘and’. Quote strings and enums with single quotes and double embedded apostrophes, for example subject eq ‘Bob”s update’. Do not quote booleans or dates. Valid quoted DateTimeOffset literals are unquoted automatically only for receivedDateTime and sentDateTime. Do not combine filter with search. When using orderby, start filter with every sort property in the same order. Prefer from_address over a raw from/emailAddress/address filter when sorting because Graph can reject the nested filter as InefficientFilter; provider rejections are retried without sorting and reported in composio_execution_message.
string
ID or well-known name of the mail folder. Well-known names (case-insensitive): archive, clutter, conflicts, conversationhistory, deleteditems, drafts, inbox, junkemail, localfailures, msgfolderroot, outbox, recoverableitemsdeletions, scheduled, searchfolders, sentitems, serverfailures, syncissues. Use ‘allfolders’ to search across all mail folders (uses /messages endpoint without folder filter). Or use a valid folder ID (base64-like string, e.g., ‘AAMkAGI0ZjExAAA=’). Accepts both raw folder IDs and percent-encoded folder IDs (with %XX sequences).
string
Full-text search query using Microsoft Graph $search syntax. Searches across subject, body, and sender fields server-side. Cannot be combined with filter, orderby, or skip; those parameters are omitted when search is set. Example: ‘budget report’ or ‘from:john@example.com’
array
Message properties to include. Accepts a list of strings or a comma-separated string (e.g., ‘id,subject,from’). Valid properties: id, subject, from, toRecipients, ccRecipients, bccRecipients, receivedDateTime, sentDateTime, hasAttachments, importance, isRead, body, bodyPreview, categories, conversationId, conversationIndex, flag, internetMessageHeaders, parentFolderId, replyTo, sender, webLink, isDraft, isReadReceiptRequested, isDeliveryReceiptRequested, changeKey, createdDateTime, lastModifiedDateTime, inferenceClassification, internetMessageId. Note: attachments is not selectable.
boolean
Filter by read status: ‘true’ for read, ‘false’ for unread. Unspecified means no filter by read status.
array
Properties to sort by, such as ‘receivedDateTime desc’. Default is ‘receivedDateTime desc’. When combined with filter, every orderby property must also appear first in filter in the same order; for example filter=‘sentDateTime ge 2026-01-01T00:00:00Z’ requires orderby=[‘sentDateTime desc’]. The action reorders its simple filter clauses when the sort property is already filtered. If Graph rejects a filter/order combination as InefficientFilter, the action retries without sorting and reports that fallback.
string
Filter by exact match of the subject line. Special characters like apostrophes, brackets will be automatically escaped. For complex subject searches, consider using ‘Search Messages’ instead.
string
Target user’s email or ‘me’ for authenticated user. For delegated access, use shared mailbox or delegated user’s email.
array
Filter by categories (case-sensitive); matches if tagged with any specified category.
string
Filter by importance: ‘low’, ‘normal’, or ‘high’.
string
Opaque continuation token for fetching the next page. Omit it for the first page; then pass back the next_page_token from the previous response, unmodified, repeating until it is absent. Do not construct or edit this value. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and paging params need not be repeated; the token carries them.
string
Filter by the sender’s exact email address. NOTE: This filter is applied client-side on the returned results, not server-side.
string
Filter messages by conversation ID to retrieve all messages in a specific email thread. NOTE: This filter is applied client-side on the returned results.
boolean
Filter by attachment presence: ‘true’ for messages with attachments, ‘false’ for those without. NOTE: This filter is applied client-side on the returned results.
string ("minimal" | "full")
Level of detail in the response. ‘minimal’ (default) applies a default $select projection that excludes the heavy ‘body’, ‘uniqueBody’, and ‘internetMessageHeaders’ fields to keep responses small — typical for listing/search use cases. ‘full’ returns the complete message payload from Microsoft Graph, including the full HTML body. Note: an explicit select list always wins over response_detail — pass select=[‘body’,‘subject’,…] to control the fields directly.
string
Filter messages where the subject contains the specified case-insensitive substring. NOTE: This filter is applied client-side on the returned results. For better performance, use ‘Search Messages’ instead.
string
Filter messages where the subject ends with the specified case-insensitive string. NOTE: This filter is applied client-side on the returned results. For better performance, use ‘Search Messages’ instead.
string
Filter messages sent after this ISO 8601 DateTimeOffset timestamp. Include a timezone, for example 2023-01-10T14:30:00Z. For inclusive ge/le comparisons, use filter with an unquoted date literal.
string
Filter messages sent before this ISO 8601 DateTimeOffset timestamp. Include a timezone, for example 2023-02-20T10:00:00Z. For inclusive ge/le comparisons, use filter with an unquoted date literal.
string
Filter messages where the subject starts with the specified case-insensitive string.
string
Filter messages received on or after this ISO 8601 DateTimeOffset timestamp. Include a timezone, for example 2023-03-15T08:00:00Z.
string
Filter messages received after this ISO 8601 DateTimeOffset timestamp. Include a timezone, for example 2023-01-01T00:00:00Z.
string
Filter messages received on or before this ISO 8601 DateTimeOffset timestamp. Include a timezone, for example 2023-03-31T23:59:59Z.
string
Filter messages received before this ISO 8601 DateTimeOffset timestamp. Include a timezone, for example 2023-04-01T00:00:00Z.
boolean
When true, retrieves and normalizes Microsoft Purview sensitivity labels in the same Graph request. Requires Mail.Read or Mail.ReadWrite. Treat status unknown as fail-closed before using a message’s content. The setting is preserved in next_page_token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_NOTIFICATION_SUBSCRIPTIONSList Microsoft Graph webhook subscriptions visible to the caller.

Input Parameters

string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_ORGANIZATIONSList the connected Microsoft Entra tenant’s organization profile. With User.Read, Microsoft returns only id, displayName, and verifiedDomains; request Organization.Read.All when other properties are needed.

Input Parameters

string
Organization properties to return. Pass a list or comma-separated string; both are sent as one OData $select value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_OUTLOOK_ATTACHMENTSList attachments for one Outlook email message. response_detail=‘minimal’ returns projected metadata only; ‘full’ also returns base64 contentBytes for file attachments and can produce a large response. Returns fileAttachment, itemAttachment, and referenceAttachment records, including inline images and signatures. Only fileAttachment records can be downloaded with OUTLOOK_DOWNLOAD_OUTLOOK_ATTACHMENT. Results are under data.response_data.value.

Input Parameters

integer
Maximum number of attachment records to return (OData $top).
string
The unique identifier of the user. Use the user’s UPN (e.g., ‘AdeleV@contoso.onmicrosoft.com’) or ‘me’ for the currently authenticated user. This specifies the mailbox to query.
string
required
The unique identifier of the email message from which to retrieve attachments. Must be a message ID (obtained from OUTLOOK_LIST_MESSAGES or OUTLOOK_SEARCH_EMAILS), not a folder ID or calendar event ID. Folder IDs look similar but will cause an error. When sourcing from OUTLOOK_SEARCH_EMAILS, use hitId as the message identifier — not resource.id.
string ("minimal" | "full")
Level of detail in the response. ‘minimal’ (default) returns only the attachment metadata that exists on the Graph attachment base type (id, name, size, contentType, isInline, lastModifiedDateTime) — the base64-encoded contentBytes and any fileAttachment-only fields (contentId, contentLocation) are excluded so the heavy file payload never leaves Microsoft Graph. ‘full’ returns the complete payload including contentBytes for downloading.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_PLACESRetrieves a collection of place objects defined in a tenant by type. Places can include rooms, workspaces, buildings, floors, sections, desks, and room lists. When room_list_id is provided, returns only rooms or workspaces within that specific room list using the /places/{roomListId}/microsoft.graph.roomlist/rooms (or /workspaces) endpoint. Use this action when you need to discover available physical spaces or locations within an organization. Note: Before using this API, ensure that the Places settings are properly configured in the tenant.

Input Parameters

integer
Maximum number of places to return per page. Default is 25. API defaults: 100 for rooms/workspaces/room lists, 1000 for buildings/floors/sections/desks.
integer
Number of places to skip for pagination (OData $skip).
boolean
Include count of items (OData $count=true). Only supported for room, workspace, and room_list types.
string
OData filter expression to restrict returned places (OData $filter). Only supported for room, workspace, and room_list types. Example: capacity gt 50.
array
List of place properties to include in the response (OData $select). Example: displayName, emailAddress, capacity.
string ("microsoft.graph.room" | "microsoft.graph.workspace" | "microsoft.graph.roomlist" | "microsoft.graph.building" | "microsoft.graph.floor" | "microsoft.graph.section" | "microsoft.graph.desk")
required
The type of place to retrieve. Choose from: room, workspace, room_list, building, floor, section, or desk.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
The email address of a room list. When provided, scopes the results to rooms or workspaces within that specific room list using the MS Graph endpoint GET /places/{roomListId}/microsoft.graph.roomlist/rooms (or /workspaces). Must be the room list’s email address (not its ID). Only valid when place_type is ‘room’ or ‘workspace’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_PLANNER_PLAN_BUCKETSList one page of buckets belonging to a Microsoft Planner basic plan.

Input Parameters

string
required
Unique identifier of the Microsoft Planner plan whose buckets to list.
string
Opaque continuation token returned as next_page_token by a previous call for the same plan. Pass it back unmodified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_PRIMARY_CALENDAR_PERMISSIONSTool to list calendar permissions from a user’s primary calendar. Use when you need to see who has access to the primary calendar and their permission levels.

Input Parameters

integer
Maximum number of permissions to return (OData $top parameter).
integer
Number of permissions to skip (OData $skip parameter).
string
User ID or userPrincipalName. Use ‘me’ for the signed-in user.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_REMINDERSTool to retrieve reminders for events occurring within a specified time range. Use when you need to see upcoming reminders between two datetimes.

Input Parameters

string
User Principal Name or ID. Use ‘me’ to indicate the signed-in user.
string
required
The end date and time in ISO 8601 format defining the window for reminders. Example: ‘2023-10-26T20:00:00.0000000’.
string
required
The start date and time in ISO 8601 format defining the window for reminders. Example: ‘2023-10-26T19:00:00.0000000’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_SENT_ITEMS_MESSAGESList a page of messages in the SentItems folder of the signed-in user or a specified user’s mailbox, with optional filtering and sorting. Use the returned continuation token to retrieve further pages.

Input Parameters

integer
Maximum number of messages to return per request (1-1000). To page through more, use the next_page_token from the response (pass it back as page_token).
integer
Number of messages to skip from the beginning of the result set, for pagination.
string
OData $filter query to filter messages. Examples: ‘isRead eq false’, ‘toRecipients/any(a:a/emailAddress/address eq “recipient@example.com”)’, ‘sentDateTime ge 2023-01-01T00:00:00Z’, ‘hasAttachments eq true’. Note: Combining complex filters with the ‘orderby’ parameter may fail with an InefficientFilter error. In such cases, remove ‘orderby’ or apply sorting client-side.
array
List of message properties to include in the response. OData $select parameter. Valid properties include: id, subject, from, toRecipients, receivedDateTime, sentDateTime, hasAttachments, importance, isRead, body, bodyPreview, categories, conversationId.
string
Property to sort results by with direction. OData $orderby parameter. Example: ‘sentDateTime desc’ or ‘subject asc’. Note: Using ‘orderby’ together with complex ‘filter’ queries may fail with an InefficientFilter error. If this occurs, either remove ‘orderby’ or apply sorting client-side.
string
User ID (GUID) or user principal name (email) of the user whose sent items to list. Required for app-only (S2S) authentication. Not required for delegated authentication (uses signed-in user by default).
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
boolean
When true, retrieves and normalizes Microsoft Purview sensitivity labels in the same Graph request. Requires Mail.Read. Treat status unknown as fail-closed. Preserved in next_page_token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_TO_DO_LISTSList Microsoft To Do task lists for the signed-in user or a specified user. Use to discover task lists before listing or creating tasks; results include list IDs and may include display names.

Input Parameters

integer
Maximum number of task lists to return (OData $top).
integer
Number of task lists to skip from the beginning of the result set (OData $skip). Use with $top for pagination.
string
OData filter expression to filter task lists (OData $filter).
array
Properties to include in the response (OData $select).
array
Order by expressions (OData $orderby).
string
User ID or userPrincipalName. Use ‘me’ for the signed-in user.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_TODO_TASKSTool to list tasks within a specified Microsoft To Do task list, including status and due dates. Use when retrieving tasks from a specific To Do list.

Input Parameters

integer
Maximum number of tasks to retrieve per page (OData $top parameter). Use for pagination.
integer
Number of tasks to skip before returning results (OData $skip parameter). Use with ‘top’ for offset-based pagination.
string
OData filter expression to narrow down results (OData $filter parameter). Use for filtering by status, importance, dates, etc. Examples: “status eq ‘notStarted’”, “importance eq ‘high’”, “dueDateTime/dateTime ge ‘2024-01-01T00:00:00Z’”
array
List of properties to sort results by (OData $orderby parameter). Each item is a string like ‘dueDateTime/dateTime desc’ or ‘title asc’. Use ‘asc’ (default) or ‘desc’ for sort order.
string
The unique identifier (GUID) or user principal name (email) of the user. Required for app-only (S2S) authentication. If not provided, defaults to ‘/me’ endpoint (delegated authentication).
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
required
The unique identifier of the To Do task list to retrieve tasks from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_USER_CALENDAR_EVENT_INSTANCESTool to retrieve instances (occurrences) of a recurring event from a specific calendar within a date range. Use when you need event instances from a particular calendar.

Input Parameters

integer
Maximum number of event instances to return per page (OData $top). Controls page size for pagination.
integer
Number of event instances to skip from the beginning of the result set (OData $skip). Use with $top for pagination.
string
required
The unique identifier of the user (can be user ID, userPrincipalName, or ‘me’ for authenticated user).
string
required
The unique identifier of the recurring event (seriesMaster) for which to retrieve instances.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
required
The unique identifier of the calendar containing the event.
string
required
The end date and time of the time range in ISO 8601 format (e.g., ‘2026-04-30T23:59:59.0000000’). Only instances that start within or overlap this range will be returned.
string
required
The start date and time of the time range in ISO 8601 format (e.g., ‘2026-03-01T00:00:00.0000000’). Only instances that start within or overlap this range will be returned.
boolean
When true, retrieves and normalizes Microsoft Purview sensitivity labels in the same Graph request. Requires Calendars.Read. Treat status unknown as fail-closed. Preserved in next_page_token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_USER_CALENDAR_EVENTS_ATTACHMENTSList a page of attachments for a specific event in a user’s calendar. The response may include a next link when more results are available.

Input Parameters

integer
Maximum number of attachments to return (OData $top).
integer
Number of attachments to skip (OData $skip).
string
OData filter string to filter the attachments (OData $filter).
array
List of attachment properties to include (OData $select).
array
Order by clauses to sort the results (OData $orderby).
string
The user’s primary SMTP address, UPN, or ‘me’ for the signed-in user.
string
required
The unique identifier of the calendar event to retrieve attachments from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_USER_CALENDAR_GROUP_EVENT_INSTANCESTool to list instances (occurrences) of a recurring event within a specified date range from a user’s calendar in a calendar group. Use when you need to retrieve specific occurrences of a recurring event.

Input Parameters

integer
Maximum number of event instances to return per page (OData $top). Controls page size for pagination.
integer
Number of event instances to skip from the beginning of the result set (OData $skip). Use with $top for pagination.
string
required
The unique identifier of the user (can be user ID or userPrincipalName).
string
required
The unique identifier of the event.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
required
The unique identifier of the calendar.
string
required
The end date and time of the time range in ISO 8601 format (e.g., ‘2026-05-01T00:00:00.0000000’).
string
required
The start date and time of the time range in ISO 8601 format (e.g., ‘2026-03-01T00:00:00.0000000’).
string
required
The unique identifier of the calendar group.
boolean
When true, retrieves and normalizes Microsoft Purview sensitivity labels in the same Graph request. Requires Calendars.Read. Treat status unknown as fail-closed. Preserved in next_page_token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_USER_CALENDAR_GROUPS_CALENDAR_VIEWTool to get calendar view from a specific calendar within a calendar group for a user. Use when retrieving events from a calendar that belongs to a calendar group.

Input Parameters

integer
Maximum number of events to return per page (OData $top). Controls page size for pagination.
integer
Number of events to skip from the beginning of the result set (OData $skip). Use with $top for pagination.
string
required
The user ID or userPrincipalName. Examples: ‘6640adbb5cb743b0’ or ‘user@example.com’.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
required
The calendar ID within the calendar group. This is the unique identifier of the specific calendar.
string
required
The end date and time of the time range in ISO 8601 format (e.g., ‘2025-01-31T23:59:59Z’ or ‘2019-11-08T20:00:00-08:00’).
string
required
The start date and time of the time range in ISO 8601 format (e.g., ‘2025-01-01T00:00:00Z’ or ‘2019-11-08T19:00:00-08:00’).
string
required
The calendar group ID. This is the unique identifier of the calendar group containing the calendar.
boolean
When true, retrieves and normalizes the Microsoft Purview sensitivity label applied to each calendar event. This is distinct from the event’s built-in sensitivity field and any Teams meeting label. Preserved in next_page_token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_USER_CALENDARS_CALENDAR_PERMISSIONSTool to list calendar permissions for a specific user’s specific calendar. Use when you need to see who has access to a user’s calendar and their permission levels.

Input Parameters

integer
Maximum number of permissions to return (OData $top parameter).
integer
Number of permissions to skip (OData $skip parameter).
string
required
The unique identifier of the user. Cannot use ‘me’ shortcut - must be actual user ID or userPrincipalName.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
required
The unique identifier of the calendar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_USER_CALENDARS_EVENTSTool to retrieve events from a specific calendar for a user. Use when you need to list calendar events for a specific user by user ID and calendar ID.

Input Parameters

integer
Maximum number of events to retrieve per page for pagination.
integer
Number of initial events to bypass, used for pagination.
string
OData query string to filter calendar events. ONLY the following properties support filtering: ‘start/dateTime’, ‘end/dateTime’, ‘subject’, ‘categories’, ‘importance’, ‘sensitivity’, ‘isAllDay’, ‘isCancelled’, ‘isReminderOn’, ‘type’. CRITICAL: Properties like ‘body’, ‘bodyPreview’, ‘location’, ‘locations’, ‘organizer’, ‘attendees’ do NOT support $filter and will cause errors. IMPORTANT: Use calendar event properties ONLY. Do NOT use mail/message properties like ‘receivedDateTime’. For start/end filtering, you MUST use ‘start/dateTime’ and ‘end/dateTime’ ONLY. DO NOT use ‘start/date’ or ‘end/date’ - these properties do NOT exist and will cause errors. DateTime format: “start/dateTime ge ‘YYYY-MM-DDTHH:MM:SSZ’” (requires single quotes and timezone suffix). Operators: ge (>=), le (<=), eq (=), gt (>), lt (<). DateTime values without quotes or timezone suffix will be automatically normalized.
array
List of specific event property names to return. MUST be provided as a list. If omitted, a default set of properties is returned. Valid field names: id, subject, body, bodyPreview, start, end, isAllDay, organizer, attendees, location, locations, recurrence, importance, sensitivity, showAs, categories, hasAttachments, webLink, onlineMeeting, onlineMeetingProvider, onlineMeetingUrl, isOnlineMeeting, createdDateTime, lastModifiedDateTime, changeKey, iCalUId, type, seriesMasterId, isOrganizer, isReminderOn, reminderMinutesBeforeStart, responseRequested, responseStatus, allowNewTimeProposals, hideAttendees, isCancelled, isDraft, originalStart, originalStartTimeZone, originalEndTimeZone, transactionId, cancelledOccurrences. Note: ‘creator’ is NOT a valid field - use ‘organizer’ instead. Invalid field names will be automatically filtered out.
array
List of properties to sort results by. Each item is a string like ‘start/dateTime desc’ or ‘subject asc’. MUST be provided as a list, even for single sort criteria. Use ‘asc’ (default) or ‘desc’ for order. IMPORTANT: Use calendar event properties ONLY. Do NOT use mail/message properties like ‘receivedDateTime’. Valid sortable datetime fields: ‘start/dateTime’, ‘end/dateTime’, ‘createdDateTime’, ‘lastModifiedDateTime’.
string
required
The user’s primary SMTP address, user principal name (UPN), or user ID to identify the calendar owner.
string
Preferred timezone for event start/end times. Accepts IANA format (e.g., ‘America/New_York’, ‘Europe/London’, ‘Asia/Tokyo’) or Windows format (e.g., ‘Eastern Standard Time’, ‘Pacific Standard Time’). Falls back to ‘UTC’ if the timezone cannot be resolved.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
required
The unique identifier of the calendar to retrieve events from.
boolean
When true, retrieves and normalizes the Microsoft Purview sensitivity label stored on each calendar event. This is distinct from the event’s built-in sensitivity field and from a Teams online meeting sensitivity label.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_USER_CALENDAR_VIEWTool to get calendar view from a specific user’s calendar. Use when you need to retrieve events that occur or overlap with a specified time window from a user’s specific calendar by calendar ID.

Input Parameters

integer
Maximum number of events to retrieve.
array
List of event properties to return. Defaults to commonly-needed fields excluding the full HTML body. To include the full body content, explicitly add ‘body’ to this list.
string
required
The ID of the user or ‘me’ for the authenticated user. This can be the user’s email address or their unique identifier.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
string
required
The unique identifier of the calendar to retrieve events from. Get calendar IDs using the LIST_CALENDARS action.
string
required
The end date and time of the time range in ISO 8601 format with timezone offset (e.g., ‘2024-12-31T23:59:59-08:00’ or ‘2024-12-31T23:59:59+00:00’ for UTC). Events active up to this time will be included.
string
required
The start date and time of the time range in ISO 8601 format with timezone offset (e.g., ‘2024-01-01T00:00:00-08:00’ or ‘2024-01-01T00:00:00+00:00’ for UTC). Events active during this window will be returned.
boolean
When true, retrieves and normalizes the Microsoft Purview sensitivity label applied to each calendar event. This is distinct from the event’s built-in sensitivity field and any Teams meeting label. Preserved in next_page_token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_USER_CONTACTSTool to retrieve contacts from a specific user’s mailbox. Use when you need to list or browse contacts for a given user.

Input Parameters

integer
Maximum number of contacts to return. OData $top parameter.
integer
Number of contacts to skip for pagination. OData $skip parameter.
boolean
If true, includes a count of the total number of items in the result. OData $count parameter.
array
Related entities to expand inline. OData $expand parameter.
string
OData filter expression to filter contacts. Example: emailAddresses/any(a:a/address eq ‘garth@contoso.com’) or startswith(displayName,‘A’).
array
List of properties to include in the response. OData $select parameter. Valid properties: displayName, givenName, surname, emailAddresses, mobilePhone, businessPhones, jobTitle, companyName, etc.
array
List of properties to order results by. OData $orderby parameter. Format: ‘property asc’ or ‘property desc’.
string
required
User principal name or ID of the user. Use ‘me’ for the authenticated user.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_LIST_USERSList or search Microsoft Entra ID users by plain display name, exact email, or account-property filters. Multi-token name searches may return broader candidates, and results can include the signed-in user regardless of the requested filter, so verify matches before use. Use page tokens to continue through results; the maximum page size is 999.

Input Parameters

integer
Maximum number of users to return (OData $top). Name searches default to 25; ordinary list calls retain Microsoft Graph’s default page size of 100. Maximum is 999.
integer
Number of users to skip (OData $skip) for pagination.
string
OData filter expression to restrict returned users (OData $filter). Use search for name lookups, not startswith on a full name. For exact lookups, use userPrincipalName eq 'user@domain.com' or mail eq 'user@domain.com' to avoid full-list pagination scans.
string
Plain display name to search for, such as Lynden Dyer; do not pass Microsoft Graph syntax. Punctuation and symbols are treated as token separators, so Dyer, Lynden, Jean-Luc, and O'Connor are searched without punctuation. Graph matches name tokens case-insensitively and in any order. If no user matches every token, the action retries once for users matching any token and returns broader candidates. Verify a result’s display name or address before using it.
array
List of user properties to include in the response (OData $select).
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_MOVE_MAIL_FOLDERTool to move a mail folder and its contents to another mail folder. Use when you need to reorganize the folder hierarchy.

Input Parameters

string
User’s email address, UPN, or ‘me’ for the currently authenticated user.
string
required
Unique ID of the mail folder to move. Must be the complete, untruncated ID string - do not use shortened or ellipsis-containing IDs.
string
required
The destination folder ID, or a well-known folder name (e.g., ‘inbox’, ‘deleteditems’, ‘drafts’, ‘sentitems’). The folder being moved will become a child of this destination folder. If using a folder ID, it must be the complete, untruncated ID string - do not use shortened or ellipsis-containing IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_MOVE_ME_MAIL_FOLDERTool to move a child mail folder to a different parent folder. Use when you need to reorganize subfolders within the folder hierarchy.

Input Parameters

string
User’s email address, UPN, or ‘me’ for the currently authenticated user.
string
required
The destination folder ID, or a well-known folder name (e.g., ‘inbox’, ‘deleteditems’, ‘drafts’, ‘sentitems’). The folder being moved will become a child of this destination folder. If using a folder ID, it must be the complete, untruncated ID string - do not use shortened or ellipsis-containing IDs.
string
required
The ID of the parent mail folder that contains the child folder to move. Must be the complete, untruncated ID string - do not use shortened or ellipsis-containing IDs.
string
required
The ID of the child folder to move. Must be the complete, untruncated ID string - do not use shortened or ellipsis-containing IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_MOVE_MESSAGEMove a message to another folder within the specified user’s mailbox. Immutable message IDs remain stable across moves within the mailbox. High-volume parallel moves can trigger HTTP 429 (MailboxConcurrency) throttling; honor the Retry-After header.

Input Parameters

string
User’s email address, UPN, or ‘me’ for the currently authenticated user.
string
required
Unique immutable ID of the Outlook email message to move. Must be the complete, untruncated ID string from an Outlook list, search, or other message action. Outlook trigger payload IDs are mutable and can become stale after a folder move.
string
required
The destination folder ID, or a well-known folder name (e.g., ‘inbox’, ‘deleteditems’, ‘drafts’, ‘sentitems’). If using a folder ID, it must be the complete, untruncated ID string - do not use shortened or ellipsis-containing IDs. Prefer folder IDs over well-known names — some tenants reject well-known names like ‘deleteditems’. Retrieve current folder IDs via OUTLOOK_LIST_MAIL_FOLDERS rather than hard-coding, as IDs can become stale. Display names are localized and non-unique; never use display names as the destination_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_MOVE_MESSAGE_FROM_CHILD_FOLDERTool to move a message from a child folder to another destination folder. Use when you need to move a message that exists within a specific folder hierarchy (parent folder → child folder → message).

Input Parameters

string
required
User’s id, userPrincipalName, or user object ID.
string
required
Unique ID of the Outlook email message to move. Must be the complete, untruncated ID string - do not use shortened or ellipsis-containing IDs.
string
required
The destination folder ID, or a well-known folder name (e.g., ‘inbox’, ‘deleteditems’, ‘drafts’, ‘sentitems’, ‘junkemail’). If using a folder ID, it must be the complete, untruncated ID string - do not use shortened or ellipsis-containing IDs.
string
required
The ID or well-known name of the parent mail folder. Common well-known names include: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. For folder IDs, obtain them from OUTLOOK_LIST_MAIL_FOLDERS. Folder IDs are base64-encoded strings (e.g., ‘AAMkAGI0ZjExAAA=’).
string
required
The ID of the child folder containing the message. Obtain this from OUTLOOK_LIST_CHILD_MAIL_FOLDERS. Child folder IDs are base64-encoded strings (e.g., ‘AAMkADAwATMwMAExAAA=’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_MOVE_MESSAGE_FROM_FOLDERTool to move a message from a specific mail folder to another destination folder. Use when you need to move a message and know both the source folder ID and the message ID.

Input Parameters

string
User’s email address, UPN, or ‘me’ for the currently authenticated user.
string
required
Unique ID of the Outlook email message to move. Must be the complete, untruncated ID string - do not use shortened or ellipsis-containing IDs.
string
required
The destination folder ID, or a well-known folder name (e.g., ‘inbox’, ‘deleteditems’, ‘drafts’, ‘sentitems’). If using a folder ID, it must be the complete, untruncated ID string - do not use shortened or ellipsis-containing IDs.
string
required
The ID or well-known name of the mail folder containing the message. ONLY these specific well-known names are valid as string names: ‘inbox’, ‘drafts’, ‘sentitems’, ‘deleteditems’, ‘junkemail’, ‘archive’, ‘outbox’, ‘clutter’, ‘conflicts’, ‘conversationhistory’, ‘localfailures’, ‘msgfolderroot’, ‘recoverableitemsdeletions’, ‘scheduled’, ‘searchfolders’, ‘serverfailures’, ‘syncissues’. Arbitrary folder names are NOT valid. If the folder is not one of these well-known names, you MUST use the actual folder ID - a base64-encoded string (e.g., ‘AAMkAGI0ZjExAAA=’) obtained from OUTLOOK_LIST_MAIL_FOLDERS or OUTLOOK_LIST_CHILD_MAIL_FOLDERS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_PERMANENT_DELETE_MESSAGEPermanently deletes an Outlook message by moving it to the Purges folder in the dumpster. Unlike standard DELETE, this action makes the message unrecoverable by the user. IMPORTANT: This is NOT the same as DELETE - permanentDelete is irreversible and availability differs by national cloud deployments (not available in US Government L4, L5 (DOD), or China (21Vianet)).

Input Parameters

string
User’s email address, UPN, or ‘me’ for the currently authenticated user.
string
required
Unique identifier of the Outlook email message to permanently delete. The message will be moved to the Purges folder in the dumpster and cannot be recovered by the user.
string
Optional mail folder ID. If provided, uses the folder-scoped endpoint: /users/{userId}/mailFolders/{mailFolderId}/messages/{messageId}/permanentDelete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_PIN_MESSAGETool to pin a message in an Outlook chat. Use when you want to mark an important message for quick access.

Input Parameters

string
required
ID of the chat where the message will be pinned.
string
User ID (GUID or email) to pin message for. Required for S2S (app-only) authentication. If not provided, uses ‘/chats’ endpoint (requires delegated authentication).
string
required
Fully qualified Graph URL of the chat message to pin. Format: https://graph.microsoft.com/v1.0/chats/&#123;chat-id&#125;/messages/&#123;message-id&#125;

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_QUERY_EMAILSQuery one Outlook mail folder using a validated OData filter, with field selection, sorting, offset, and continuation-token pagination. Requests up to 100 messages by default and up to 1,000 per page; sorting may be dropped if Graph rejects it as inefficient.

Input Parameters

integer
Maximum number of messages to return per request (1-1000). Default is 100. IMPORTANT: For large mailboxes, paginate using next_page_token. Pagination example: 1) Call with top=100, 2) Read next_page_token from the response, 3) If present, call again passing it back as page_token, 4) Repeat until next_page_token is absent.
integer
Number of messages to skip for pagination. NOTE: For large result sets, prefer the returned next_page_token (pass it back as page_token) over manual skip.
string
OData $filter query string to filter email messages. Syntax: ‘field operator value’ combined with ‘and’, ‘or’, ‘not’. Operators: eq, ne, lt, le, gt, ge, startswith(), contains(), any() String Functions: - subject: contains(), startswith() - from/sender: startswith() and eq only. contains() is NOT supported on sender/from fields - endswith() is NOT reliably supported by Microsoft Graph API for message filtering Filterable Fields: - isRead - Boolean: true/false - importance - String: ‘low’, ‘normal’, ‘high’ - subject - String (exact match or startswith) - hasAttachments - Boolean: true/false - receivedDateTime, sentDateTime - DateTime (ISO 8601: 2025-10-01T00:00:00Z, NOT enclosed in quotes) - conversationId - String (exact match) - categories - Array (use any() operator: categories/any(a:a eq 'CategoryName')) - isDraft, flag/flagStatus - Boolean/String flags - from/emailAddress/address, sender/emailAddress/address - Sender email (ONLY ‘address’ is filterable, NOT ‘name’) NOT filterable: toRecipients, ccRecipients, bccRecipients, body/content, id — use OUTLOOK_SEARCH_MESSAGES for these. Categories Filtering: - Single: categories/any(a:a eq 'CategoryName') - Multiple (OR): Use SEPARATE any() calls: categories/any(a:a eq 'Cat1') or categories/any(b:b eq 'Cat2') - For category names containing single quotes, escape them by doubling: categories/any(a:a eq 'Owner''s Category') Date Filtering: - ISO 8601 format: 2025-10-01T00:00:00Z (no quotes around datetime values) - Operators: ge, gt, le, lt
string
SINGLE mail folder to search within (cannot search across all folders). Well-known names (case-insensitive): ‘inbox’, ‘sentitems’, ‘drafts’, ‘deleteditems’, ‘outbox’, ‘junkemail’, ‘archive’, ‘clutter’, ‘recoverableitemsdeletions’. For custom folders (e.g., ‘Billing’, ‘Projects’), you MUST provide the folder ID (a long base64-like string like ‘AAMkAGU0NTRiNDA4…’). Use OUTLOOK_LIST_MAIL_FOLDERS to get folder IDs for custom folders. Do NOT pass folder URLs or display names. IMPORTANT: To search across ALL folders, use OUTLOOK_SEARCH_MESSAGES instead (searches entire mailbox without folder restriction). NOTE: This parameter also accepts ‘folder_id’ as an alias for backwards compatibility.
array
List of message properties to include in the response (accepts comma-separated string or list). Field names are automatically normalized to correct camelCase (e.g., ‘bodypreview’ -> ‘bodyPreview’, ‘hasattachments’ -> ‘hasAttachments’). Valid fields: id, subject, from, sender, toRecipients, ccRecipients, bccRecipients, replyTo, receivedDateTime, sentDateTime, createdDateTime, lastModifiedDateTime, hasAttachments, importance, isRead, isDraft, body, bodyPreview, uniqueBody, categories, conversationId, conversationIndex, parentFolderId, changeKey, internetMessageId, internetMessageHeaders, webLink, flag, attachments, inferenceClassification, isReadReceiptRequested, isDeliveryReceiptRequested. NOTE: ‘inReplyTo’ is NOT a valid property for email messages in Microsoft Graph v1.0. When not specified, returns metadata without body. Include ‘body’ for full content. Pass [] for all fields.
string
Sort order as comma-separated string or list (accepts ‘field asc/desc’ format or JSON-serialized arrays). Input is automatically normalized to correct format. Common fields: receivedDateTime, sentDateTime, subject, importance, from. NOTE: Ordering may be automatically disabled by Microsoft Graph API when using certain filters (e.g., subject exact match, conversationId) to avoid ‘InefficientFilter’ errors. In those cases, results will be unsorted.
string
Target user’s email or ‘me’ for authenticated user. IMPORTANT: ‘me’ uses the currently connected account. For shared or delegated mailbox access, ensure the connected user has mailbox access and the app has Mail.Read.Shared. 403 errors indicate insufficient delegated/application permissions.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified, until it is absent. Do not construct or edit it. When set, it drives pagination; resend any required identifier fields from the first call (the token supersedes their values). Optional filter, sort and timezone params need not be repeated; the token carries them.
boolean
When true, retrieves and normalizes Microsoft Purview sensitivity labels in the same Graph request. Requires Mail.Read or Mail.ReadWrite. Treat status unknown as fail-closed before using a message’s content. The setting is preserved in next_page_token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_REPLY_ALLSend a reply to every recipient selected by Outlook’s reply-all semantics.

Input Parameters

string
required
The plain-text comment to send to every recipient selected by Outlook’s reply-all semantics.
string
required
The mailbox UPN or user ID. Pass ‘me’ only with delegated authentication; app-only authentication requires an explicit user ID or UPN.
string
required
The complete Microsoft Graph ID of the message to reply to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_REPLY_EMAILSends a reply to an Outlook email message with optional HTML formatting, attachments, CC, and BCC recipients.

Input Parameters

string
required
The body content of the reply email. Can be plain text or HTML based on is_html flag.
boolean
Whether the comment body should be rendered as HTML (true) or plain text (false). When false, HTML tags in the comment will be displayed as literal text.
string
The user’s email address or ‘me’ to indicate the authenticated user. This specifies the mailbox from which the reply will be sent.
array
List of email addresses for CC recipients.
string
File(s) to attach to the reply. Accepts a single file or a list of files.
array
List of email addresses for BCC recipients.
string
required
The Microsoft Graph message ID (NOT an email address). This is a Base64-encoded string typically starting with ‘AAMk’ (e.g., ‘AAMkAGI2TAAA=’). Do NOT pass email addresses like ‘user@example.com’. Obtain this ID from the ‘id’ field returned by OUTLOOK_LIST_MESSAGES, OUTLOOK_GET_MESSAGE, or OUTLOOK_SEARCH_MESSAGES actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_REPORT_MESSAGEReport a message as unknown, junk, not junk, or phishing. Reporting influences Microsoft’s future mail filtering and cannot be retracted as an ordinary field update; when is_message_move_requested is true, Microsoft Graph can also move the message out of its current folder. On success, this beta operation may return either a command result with properties such as Status=Success or the message object documented by Microsoft Graph. The documented unknownFutureValue enum member is a forward-compatibility sentinel and is intentionally not exposed as a selectable report action. This action uses Microsoft Graph’s beta API, which is subject to change and is not supported by Microsoft for production applications.

Input Parameters

string
required
Complete ID of the message in the connected user’s mailbox to report.
string ("unknown" | "junk" | "notJunk" | "phish")
required
Classification to report: unknown, junk, notJunk, or phish. The documented unknownFutureValue member is a forward-compatibility sentinel for values introduced after this action and is intentionally not selectable.
boolean
required
Whether Microsoft Graph should move the message out of its current folder as part of the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_SEARCH_EVENTSSearches for calendar events in the authenticated user’s primary calendar. Work and school accounts use Microsoft Graph Search. When Microsoft Graph reports that Search is unsupported for a personal Microsoft account, the action searches a caller-supplied calendarView window locally by matching every whitespace-separated keyword across subject, body preview, location, and attendees.

Input Parameters

integer
Maximum results per work or school Microsoft Search page. For the personal Microsoft account fallback, this limits calendar candidates examined in one provider page, so it can return fewer keyword matches; use next_page_token to continue scanning. The default is 25.
string
The search query string to find calendar events. Required on the first page and omitted when continuing with page_token. For personal Microsoft accounts, the fallback treats this as plain, case-insensitive terms across subject, body preview, location, and attendees. Every whitespace-separated term must match; Microsoft Search query syntax is not available.
integer
The zero-based starting index for pagination. Use this to skip results and fetch the next page.
string
Opaque continuation token for a personal-account fallback result. Omit for the first page; then pass back next_page_token unmodified. When set, it carries the date window and keyword from the first request and advances one calendar candidate page.
string
End of the ISO 8601 calendar window for the personal Microsoft account fallback. Must be supplied with start_datetime when Microsoft Search is unavailable for that account; ignored for normal Microsoft Search requests.
string
Start of the ISO 8601 calendar window for the personal Microsoft account fallback. Must be supplied with end_datetime when Microsoft Search is unavailable for that account; ignored for normal Microsoft Search requests.
boolean
When true, hydrates each search hit’s Microsoft Purview sensitivity label through Graph JSON batches capped at 20 requests per batch. This is distinct from the event’s built-in sensitivity field and from a Teams online meeting sensitivity-label assignment. Requires Calendars.Read. Treat status unknown as fail-closed before using event content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_SEARCH_MESSAGESSearch Outlook messages using KQL syntax. Supports Microsoft 365, work/school, and personal Microsoft accounts. Personal accounts use the Messages API fallback. Examples: ‘from:user@example.com AND received>=2025-10-01’, ‘to:info@jcdn.nl AND subject:invoice’, ‘received>today-30 AND hasattachment:yes’

Input Parameters

integer
Number of search results to return per page (1-25). Note: For message entity, max size is 25. Also, from_index + size cannot exceed 1000 (API pagination window limit).
string
KQL (Keyword Query Language) search query string. Supports advanced syntax for precise searches. Basic Syntax: - Simple keywords: ‘budget report’ - Exact phrases: ‘“quarterly review”’ - Boolean operators: ‘urgent AND deadline’ or ‘invoice OR receipt’ Property Filters (prefix:value): - from: Sender email - ‘from:user@example.com’ or ‘from:example.com’ - to: Recipient email - ‘to:info@jcdn.nl’ - cc: CC recipient - ‘cc:manager@example.com’ - subject: Subject line - ‘subject:invoice’ - received: Date received - ‘received:2025-10-01’ or ‘received>=2025-10-01’ - sent: Date sent - ‘sent:2025-10-01’ or ‘sent>=2025-10-01’ - hasattachment: Has files - ‘hasattachment:yes’ or ‘hasattachment:no’ REQUIRED: For a first page, provide this query parameter OR one of the legacy filters (fromEmail, subject, hasAttachments). For a continuation page, provide page_token.
string
Geographic region for the search query. ONLY required when using application permissions (S2S authentication). DO NOT use with delegated permissions (user authentication) - the API will reject the request. Common values: ‘US’, ‘EU’, ‘GB’, ‘JP’, ‘CN’, ‘IN’, ‘CA’, ‘AU’, ‘BR’, ‘RU’. Leave unset (None) for delegated permissions.
string
Text to search for within the message subject line. Legacy parameter - prefer using ‘subject:text’ in the query parameter for more control. When combined with query, this filter is joined using AND. If query contains OR operators, the query is wrapped in parentheses to preserve precedence. Example: Instead of subject=‘invoice’, use query=‘subject:invoice AND received>=2025-10-01’
string
Target mailbox: ‘me’ for the signed-in user, or an email/UPN for a shared/other mailbox (e.g., ‘support@example.com’). Shared-mailbox access requires Mail.Read.Shared (delegated) or Mail.Read (application) on the target; 403 means insufficient permissions. Behavior differs by value: ‘me’ uses the Microsoft Search API, but personal Microsoft accounts automatically fall back to the Messages API with $search; a specific mailbox uses the Messages API directly (responses are normalized back into the same hitsContainers/hits shape, so callers don’t need to branch). region and enable_top_results apply only when the Microsoft Search API is used. Messages API search pagination uses the response’s opaque next_page_token; do not set from_index above zero on that path. When continuing a shared-mailbox search, resend this user_id with page_token.
string
Filter messages by sender email address or domain. Supports exact email (‘user@example.com’) or domain matching (‘example.com’). Legacy parameter - prefer using ‘from:email@example.com’ in the query parameter for more flexibility. When combined with query, this filter is joined using AND. If query contains OR operators, the query is wrapped in parentheses to preserve precedence.
integer
The 0-based starting index for Microsoft Search API pagination (max 999). Note: from_index + size cannot exceed 1000 (API pagination window limit). To paginate: check response[‘value’][0][‘hitsContainers’][0][‘moreResultsAvailable’]. For Microsoft Search API results, if true, call again with from_index += size (e.g., 0 → 25 → 50). For Messages API fallback results, pass the response’s next_page_token as page_token instead.
string
Opaque continuation token for the next Messages API fallback page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified. Do not construct or edit it. When set, it preserves the original mailbox, query, and page size. Also resend the original user_id for a shared mailbox so connection requirements can be evaluated correctly.
boolean
Filters messages based on the presence of attachments. Legacy parameter - prefer using ‘hasattachment:yes’ or ‘hasattachment:no’ in the query parameter. When combined with query, this filter is joined using AND. If query contains OR operators, the query is wrapped in parentheses to preserve precedence.
boolean
If true, sorts results by relevance; otherwise, sorts by date in descending order (newest first).
boolean
When true, hydrates each search hit’s Microsoft Purview sensitivity label through Graph JSON batches capped at 20 requests per batch. Requires Mail.Read or Mail.ReadWrite. Treat status unknown as fail-closed before using the search result’s message content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_SEARCH_PEOPLEList relevant people, optionally searching by fuzzy name or alias.

Input Parameters

integer
Maximum number of people to return in this page (OData $top).
integer
Number of results to skip. Cannot be used with search.
string
OData filter expression used to limit returned people.
string
Fuzzy name or alias to search for among people relevant to the signed-in user.
array
Person properties to return (OData $select).
string
OData expression used to order returned people.
string
Opaque continuation token for the next page. Omit for the first page; then pass back the next_page_token from the previous response, unmodified. The token preserves the original search options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_SEARCH_SITESSearch the connected Microsoft 365 tenant for SharePoint sites.

Input Parameters

string
required
Free-text query used to search SharePoint sites in the tenant.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_SEND_DRAFTTool to send an existing draft message. Use after creating a draft when you want to deliver it to recipients immediately. Example: Send a draft message with ID ‘AAMkAG…’.

Input Parameters

string
The user’s email address or ‘me’ to represent the authenticated user.
string
required
The unique identifier of the draft message to send.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_SEND_EMAILSends an email with subject, body, recipients, and optional attachments via Microsoft Graph API. Supports comma-separated email addresses in the to_email field for multiple recipients. Accepts either a single file or a list of files as attachments. Attachments require a non-empty file with valid name and mimetype.

Input Parameters

string
required
The primary recipient’s email address(es). You can provide a single email or multiple emails separated by commas. Valid email addresses will be extracted from strings containing extra text. Format: name@domain.com
string
required
The content of the email body as a plain string (plain text or HTML based on is_html). Do not pass structured objects; provide only the raw text/HTML content.
boolean
Specifies if the email body is HTML; True for HTML, False for plain text.
string
required
The subject line of the email.
string
The display name of the primary recipient.
string
The user’s email address or the alias ‘me’ to represent the authenticated user.
array
List of email addresses for CC recipients. Each email should be a separate string in the array. Do NOT pass comma-separated values as a single string.
string
File(s) to attach. Accepts a single file or a list of files.
array
List of email addresses for BCC recipients. Each email should be a separate string in the array. Do NOT pass comma-separated values as a single string.
string
Optional From address to set on the message (send as/on behalf). Provide a single email address. Requires appropriate mailbox permissions.
boolean
Indicates if the email should be saved in ‘Sent Items’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_SNOOZE_CALENDAR_GROUP_EVENT_REMINDERTool to snooze a reminder for a user’s calendar event within a calendar group to a new time. Use when you need to postpone an event reminder for a specific user’s calendar that belongs to a calendar group.

Input Parameters

string
The user’s primary SMTP address, user principal name (UPN), or the alias ‘me’ (for the signed-in user) to identify the calendar owner.
string
required
The unique identifier of the event whose reminder should be snoozed.
string
required
The unique identifier of the calendar within the calendar group.
string
required
The unique identifier of the calendar group containing the calendar.
object
required
The new date, time, and time zone when the reminder should trigger again.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_SNOOZE_EVENT_REMINDERTool to postpone an event reminder until a new time. Use when you need to delay a reminder for a calendar event.

Input Parameters

string
The unique identifier (GUID) or user principal name (email) of the user. Required for app-only (S2S) authentication. If not provided, uses ‘/me’ endpoint.
string
required
The unique identifier of the calendar event whose reminder should be snoozed.
object
required
The new date and time when the reminder should fire.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_SNOOZE_USER_CALENDAR_EVENT_REMINDERTool to snooze a reminder for a calendar event in a specific user calendar to a new time. Use when you need to postpone an event reminder for a specific calendar.

Input Parameters

string
The user’s primary SMTP address, user principal name (UPN), or the alias ‘me’ (for the signed-in user) to identify the calendar owner.
string
required
The unique identifier of the calendar event whose reminder should be snoozed.
string
required
The unique identifier of the calendar containing the event.
object
required
The new date, time, and time zone when the reminder should trigger again.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_SNOOZE_USER_EVENT_REMINDERSnoozes a reminder for an event in a user’s default calendar to a new time.

Input Parameters

string
The user’s primary SMTP address, user principal name (UPN), or the alias ‘me’ (for the signed-in user) to identify the calendar owner.
string
required
The unique identifier of the calendar event whose reminder should be snoozed.
object
required
The new date, time, and time zone when the reminder should trigger again.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_TRANSLATE_EXCHANGE_IDSTranslate Outlook resource IDs between supported Exchange ID formats.

Input Parameters

string
User principal name, user ID, or ‘me’ for the signed-in user. App-only authentication requires an explicit user principal name or ID.
array
required
Exchange identifiers to translate. All IDs must have the same source format and belong to the same mailbox.
string ("entryId" | "ewsId" | "immutableEntryId" | "restId" | "restImmutableEntryId")
required
Format of every identifier in input_ids.
string ("entryId" | "ewsId" | "immutableEntryId" | "restId" | "restImmutableEntryId")
required
Format to which the identifiers are translated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_CALENDAR_EVENTUpdates specified fields of an existing Outlook calendar event, including subject, time, attendees, location, categories, and recurrence.

Input Parameters

object
Event body with content type (‘Text’ or ‘HTML’) and the content. If omitted, the existing body remains unchanged.
string
Availability status for the event. Valid values: ‘free’, ‘tentative’, ‘busy’, ‘oof’. If omitted, the existing status remains unchanged.
string
New subject for the event. If provided as an empty string, the subject will be cleared. If omitted, the existing subject remains unchanged.
string
The identifier of the user whose calendar event is to be updated. Accepts the user’s principal name, ID, or ‘me’ for the currently authenticated user.
string
required
The unique identifier of the calendar event to be updated. This ID can be obtained from the OUTLOOK_LIST_EVENTS action.
string
Event location. Can be provided as a simple string (e.g., ‘Conference Room A’) which will be converted to displayName, or as a dictionary with fields like displayName, address, etc. If provided, replaces the existing primary location. Omit to leave unchanged.
array
Attendee list for the event. If provided, replaces the existing attendees. If omitted, attendees remain unchanged.
string
IANA or Windows time zone for start_datetime and/or end_datetime. If omitted, naive values use the event’s original zone, not the UTC zone shown by OUTLOOK_GET_EVENT or OUTLOOK_LIST_EVENTS; pass ‘UTC’ when using values from those responses. Offset values with no time_zone are converted to UTC.
array
Category names to associate with the event. If provided (even empty), replaces the existing categories. If omitted, categories remain unchanged. Duplicate entries (case-insensitive) are automatically removed.
object
The recurrence pattern for an event.
string
New end date and time. Prefer local YYYY-MM-DDTHH:MM:SS. If time_zone is omitted, a naive value is interpreted in the event’s original zone, not the UTC zone shown by OUTLOOK_GET_EVENT or OUTLOOK_LIST_EVENTS; pass time_zone=‘UTC’ when using a value from those responses. An offset value with no time_zone is converted to UTC.
string
New start date and time. Prefer local YYYY-MM-DDTHH:MM:SS. If time_zone is omitted, a naive value is interpreted in the event’s original zone, not the UTC zone shown by OUTLOOK_GET_EVENT or OUTLOOK_LIST_EVENTS; pass time_zone=‘UTC’ when using a value from those responses. An offset value with no time_zone is converted to UTC.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_CALENDAR_EVENT_IN_CALENDARTool to update an event in a specific Outlook calendar. Use when you need to modify event details like subject, time, attendees, or location in a non-default calendar.

Input Parameters

object
Event body with content type (‘Text’ or ‘HTML’) and the content. If omitted, the existing body remains unchanged.
string
Availability status for the event. Valid values: ‘free’, ‘tentative’, ‘busy’, ‘oof’. If omitted, the existing status remains unchanged.
string
New subject for the event. If provided as an empty string, the subject will be cleared. If omitted, the existing subject remains unchanged.
string
The user ID or principal name (email) of the user whose calendar event to update. Required for app-only (S2S) authentication. If not provided, uses the authenticated user context (/me endpoint) for delegated authentication.
string
required
The unique identifier of the calendar event to be updated. This ID can be obtained from the OUTLOOK_LIST_EVENTS action.
string
Event location. Can be provided as a simple string (e.g., ‘Conference Room A’) which will be converted to displayName, or as a dictionary with fields like displayName, address, etc. If provided, replaces the existing primary location. Omit to leave unchanged.
array
Attendee list for the event. If provided, replaces the existing attendees. If omitted, attendees remain unchanged.
string
IANA or Windows time zone for start_datetime and/or end_datetime. If omitted, naive values use the event’s original zone, not the UTC zone shown by OUTLOOK_GET_EVENT or OUTLOOK_LIST_EVENTS; pass ‘UTC’ when using values from those responses. Offset values with no time_zone are converted to UTC.
array
Category names to associate with the event. If provided (even empty), replaces the existing categories. If omitted, categories remain unchanged. Duplicate entries (case-insensitive) are automatically removed.
string
The importance of the event: low, normal, or high. If omitted, the existing value remains unchanged.
boolean
Set to true if the event lasts all day. If omitted, the existing value remains unchanged.
object
The recurrence pattern for an event.
string
required
The unique identifier of the calendar containing the event. This ID can be obtained from the OUTLOOK_LIST_CALENDARS action.
string
Sensitivity level: normal, personal, private, confidential. If omitted, the existing value remains unchanged.
string
New end date and time. Prefer local YYYY-MM-DDTHH:MM:SS. If time_zone is omitted, a naive value is interpreted in the event’s original zone, not the UTC zone shown by OUTLOOK_GET_EVENT or OUTLOOK_LIST_EVENTS; pass time_zone=‘UTC’ when using a value from those responses. An offset value with no time_zone is converted to UTC.
boolean
Set to true if an alert is set to remind the user of the event. If omitted, the existing value remains unchanged.
string
New start date and time. Prefer local YYYY-MM-DDTHH:MM:SS. If time_zone is omitted, a naive value is interpreted in the event’s original zone, not the UTC zone shown by OUTLOOK_GET_EVENT or OUTLOOK_LIST_EVENTS; pass time_zone=‘UTC’ when using a value from those responses. An offset value with no time_zone is converted to UTC.
boolean
True if this event has online meeting information. If omitted, the existing value remains unchanged.
integer
The number of minutes before the event start time that the reminder alert occurs. If omitted, the existing value remains unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_CALENDAR_GROUPTool to update the properties of a calendar group object. Use when you need to rename a calendar group.

Input Parameters

string
required
The new name for the calendar group.
string
The user’s principal name (UPN) or object ID. Use ‘me’ for the authenticated user.
string
required
The unique identifier of the calendar group to update. This ID can be obtained from the list calendar groups action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_CALENDAR_GROUP_CALENDAR_PERMISSIONTool to update a calendar permission within a calendar group. Use when changing access levels for calendars in specific groups.

Input Parameters

string ("freeBusyRead" | "limitedRead" | "read" | "write")
required
The permission level to change to for the calendar share recipient. Options: freeBusyRead (view availability only), limitedRead (view availability and titles), read (view all event details), write (view and edit events).
string
The unique identifier or email address of the user. Required for S2S (app-only) authentication. If not provided, defaults to ‘me’ for delegated authentication.
string
required
The unique identifier of the calendar within the group.
string
required
The unique identifier of the calendar permission to update.
string
required
The unique identifier of the calendar group containing the calendar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_CALENDAR_GROUPS_CALENDARSTool to update a calendar within a calendar group in a user’s mailbox. Use when modifying calendar properties like name, color, or default calendar status.

Input Parameters

string
The new display name for the calendar.
string ("auto" | "lightBlue" | "lightGreen" | "lightOrange" | "lightGray" | "lightYellow" | "lightTeal" | "lightPink" | "lightBrown" | "lightPurple" | "lightRed")
The color theme to assign to the calendar. Supported values: auto, lightBlue, lightGreen, lightOrange, lightGray, lightYellow, lightTeal, lightPink, lightBrown, lightPurple, lightRed.
string
The user’s identifier. Use ‘me’ for the signed-in user, or specify a user principal name (email) or user ID.
string
An optional hexadecimal color code for the calendar in the format ‘#RRGGBB’.
string
required
The unique identifier of the calendar to update.
string
required
The unique identifier of the calendar group containing the calendar to update.
boolean
Whether this calendar should be set as the user’s default calendar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_CALENDAR_GROUPS_CALENDARS_EVENTSTool to update an event in a calendar within a calendar group for a specific user. Use when modifying event details for a user’s calendar.

Input Parameters

object
Represents a date, time, and time zone.
object
The body content of the event.
object
Represents a date, time, and time zone.
string
The status to show on the calendar. Valid values: ‘free’, ‘tentative’, ‘busy’, ‘oof’, ‘workingElsewhere’, ‘unknown’. If omitted, the existing status remains unchanged.
string
The new subject/title of the event. If omitted, the existing subject remains unchanged.
string
required
The ID or principal name of the user whose calendar event to update. Use ‘me’ for the authenticated user.
string
required
The unique identifier of the event to update.
object
The location of an event.
array
The new list of attendees for the event. If provided, replaces the existing attendees. If omitted, attendees remain unchanged.
array
A list of category names to associate with the event. If provided, replaces the existing categories. If omitted, categories remain unchanged. Duplicate entries (case-insensitive) are automatically removed.
string
The importance of the event. Valid values: ‘low’, ‘normal’, ‘high’. If omitted, the existing importance remains unchanged.
string
required
The ID of the calendar within the calendar group containing the event.
string
required
The ID of the calendar group containing the target calendar.
boolean
Set to true to indicate that the event is an online meeting. If omitted, the existing setting remains unchanged.
string
The online meeting provider. Currently only ‘teamsForBusiness’ is supported. If omitted, the existing provider remains unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_CALENDAR_PERMISSIONTool to update calendar permission levels for share recipients or delegates. Use when you need to change the access level (role) for someone who has been granted access to a calendar.

Input Parameters

string ("freeBusyRead" | "limitedRead" | "read" | "write")
required
The permission level to change to for the calendar share recipient or delegate. Possible values: freeBusyRead (view free/busy status only), limitedRead (view free/busy status, titles and locations), read (view all details except private events), write (view all details except private events and edit events).
string
User ID, userPrincipalName, or ‘me’ for the authenticated user.
string
required
The unique identifier of the calendar.
string
required
The unique identifier of the calendar permission to update. This ID can be obtained from listing calendar permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_CHILD_FOLDER_CONTACTTool to update a contact in a child contact folder within a parent contact folder. Use when you need to modify contact properties such as name, email, phone numbers, or company details for contacts in nested folder structures.

Input Parameters

string
The contact’s title (e.g., Mr., Ms., Dr.).
string
The name of the contact’s manager.
string
The contact’s surname (last name).
string
User’s identifier; ‘me’ for the signed-in user, or user’s principal name/ID.
string
The contact’s birthday in ISO 8601 format (YYYY-MM-DD).
array
The names of the contact’s children.
string
The contact’s job title.
string
The contact’s nickname.
string
The contact’s given (first) name.
array
Categories for organizing the contact.
string
required
The unique identifier of the contact to update.
string
The contact’s department.
array
The contact’s home phone numbers.
string
The contact’s middle name.
string
The contact’s profession.
string
The name of the contact’s spouse/partner.
string
The name of the contact’s company.
string
The contact’s full display name.
object
Physical address information.
string
The contact’s mobile phone number.
string
The phonetic Japanese surname (last name) of the contact.
object
Physical address information.
string
The name of the contact’s assistant.
string
Personal notes about the contact.
string
The phonetic Japanese given name (first name) of the contact.
array
The contact’s business phone numbers.
array
The contact’s email addresses.
string
The location of the contact’s office.
object
Physical address information.
string
required
The unique identifier of the child folder containing the contact.
string
The phonetic Japanese company name of the contact.
string
required
The unique identifier of the parent contact folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_CONTACTUpdates an existing Outlook contact, identified by contact_id for the specified user_id, requiring at least one other field to be modified.

Input Parameters

string
Personal notes about the contact (maps to ‘personalNotes’ in Microsoft Graph API).
string
Contact’s surname (last name).
string
User’s identifier; ‘me’ for the signed-in user, or user’s principal name/ID.
string
Contact’s birthday (YYYY-MM-DD format).
string
Contact’s job title.
array
Categories for organizing the contact.
string
required
Unique identifier of the contact to update.
string
Contact’s department.
string
Contact’s given (first) name.
array
Contact’s home phone numbers.
string
Contact’s company name.
string
Contact’s full display name.
string
Contact’s mobile phone number.
array
Contact’s business phone numbers.
array
Contact’s email addresses. Each entry requires address (string) and optionally name (string). Replaces all existing email addresses on save; include all intended addresses, not just new ones.
string
Contact’s office location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_CONTACT_FOLDERTool to update the properties of a contact folder for a specific user. Use when you need to rename or move an existing contact folder.

Input Parameters

string
required
User principal name or ID. Use ‘me’ for the authenticated user.
string
The updated display name for the contact folder.
string
The ID of the folder’s parent folder to move this contact folder under.
string
required
The unique identifier of the contact folder to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_CONTACT_FOLDER_CHILD_FOLDERTool to update a child folder within a contact folder for a specific user. Use when you need to rename a child contact folder or move it to a different parent folder.

Input Parameters

string
required
The unique identifier of the user. Can use ‘me’ as a shortcut for the authenticated user, or provide user ID or userPrincipalName.
string
The updated display name for the child folder.
string
required
The ID of the child folder to update.
string
The ID of the new parent folder to move this child folder under.
string
required
The ID of the parent contact folder that contains the child folder to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_CONTACT_FOLDERS_CONTACTSTool to update a contact within a specific contact folder. Use when you need to modify contact details for a contact stored in a particular folder.

Input Parameters

string
Contact’s surname (last name).
string
User’s identifier; ‘me’ for the signed-in user, or user’s principal name/ID.
string
Contact’s birthday (YYYY-MM-DD format).
string
Contact’s job title.
array
Categories for organizing the contact.
string
required
Unique identifier of the contact to update.
string
Contact’s department.
string
Contact’s given (first) name.
array
Contact’s home phone numbers.
string
Contact’s company name.
string
Contact’s full display name.
object
Contact’s home address.
string
Contact’s mobile phone number.
object
Other addresses for the contact.
string
Personal notes about the contact.
array
Contact’s business phone numbers.
array
Contact’s email addresses.
string
Contact’s office location.
object
Contact’s business address.
string
required
Unique identifier of the contact folder containing the contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_EMAILUpdates specified properties of an existing email message; message_id must identify a valid message within the specified user_id’s mailbox.

Input Parameters

object
Recipient with email address for input requests.
object
New body content (Text or HTML). If omitted, the existing message body remains unchanged. Must be a dict with both contentType (‘Text’ or ‘HTML’) and content keys set together; omitting contentType defaults to plain text and will not render HTML markup.
object
Represents the flag value for a message (input).
object
Recipient with email address for input requests.
boolean
Mark message as read (True) or unread (False). If omitted, read status remains unchanged.
string
New subject line. If omitted, the existing subject remains unchanged. Provide empty string to clear the subject.
string
The UPN (User Principal Name) of the user whose mailbox contains the message, or ‘me’ for the currently authenticated user. This determines whose message is updated.
array
Email addresses to use when replying. Updatable only if isDraft = true.
array
Categories associated with the message. Provides a list of category labels (e.g., ‘Follow Up’, ‘Customer’).
string
New importance level (‘low’, ‘normal’, ‘high’). If omitted, the existing importance level remains unchanged.
string
required
The unique identifier of the email message to be updated. This ID is typically obtained from listing messages or creating/sending a message. URL-encoded IDs are automatically decoded before use.
array
List of CC recipients; replaces all existing CCs. Omitting this field preserves existing CC recipients. Provide an empty list to clear all CC recipients.
array
List of TO recipients; replaces all existing TOs. Omitting this field preserves existing TO recipients. Provide an empty list to clear all TO recipients.
array
List of BCC recipients; replaces all existing BCCs. Omitting this field preserves existing BCC recipients. Provide an empty list to clear all BCC recipients.
string
The message ID in the format specified by RFC2822. Updatable only if isDraft = true.
string
Classification of the message for the user based on inferred relevance or importance. Possible values: ‘focused’ or ‘other’.
boolean
Indicates whether a read receipt is requested for the message.
boolean
Indicates whether a delivery receipt is requested for the message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_EMAIL_RULEUpdate an existing email rule

Input Parameters

string
required
ID of the email rule to update.
object
Updated actions to take when the rule conditions are met.
string
User ID or principal name for app-only (S2S) authentication. Required for application permissions. Use the user’s GUID or email address (e.g., ‘43f0c14d-bca8-421f-b762-c3d8dd75be1f’ or ‘user@domain.com’).
integer
Updated order in which the rule is executed (lower numbers execute first). Changing this value shifts the relative order of all other rules; review existing rule sequences before updating.
boolean
Whether the rule should be enabled or disabled.
object
Updated conditions that must be met for the rule to apply.
string
Updated display name for the email rule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_EVENT_EXTENSIONTool to update an open extension on a calendar event in Microsoft Graph. Use when you need to modify custom properties stored in an event extension.

Input Parameters

string
The user identifier for the calendar owner. Must be either ‘me’ (for the authenticated user), a Microsoft 365 User Principal Name (e.g., user@contoso.com), or an Azure AD object ID (GUID).
string
required
The unique identifier of the calendar event containing the extension to update.
string
required
The unique identifier of the calendar containing the event.
string
required
The unique identifier of the extension to update. Can be the full extension ID (e.g., Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.TestExtension) or just the extension name (e.g., Com.Contoso.TestExtension).
string
required
The name of the extension. Must match the format: ‘Com.Company.ExtensionName’.
object
Custom properties to update in the extension. Each property can be a string, number, or boolean value. If not provided, only the extension name will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_EVENT_EXTENSION_IN_CALENDAR_GROUPTool to update an open extension on a calendar event within a calendar group. Use when modifying custom properties stored in an event extension for events in calendar groups.

Input Parameters

string
The unique identifier (GUID) or email address of the user whose calendar event extension to update. Required for app-only (S2S) authentication. If not provided, uses the authenticated user context (/me endpoint).
string
required
The unique identifier of the calendar event containing the extension to update.
string
required
The unique identifier of the calendar within the calendar group.
string
required
The unique identifier of the extension to update. Can be the full extension ID (e.g., Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.TestExtension) or just the extension name (e.g., Com.Contoso.TestExtension).
string
required
The name of the extension. Must match the format: ‘Com.Company.ExtensionName’.
string
required
The unique identifier of the calendar group containing the calendar.
object
Custom properties to update in the extension. Each property can be a string, number, or boolean value. If not provided, only the extension name will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_INFERENCE_CLASSIFICATIONRequest an update to a user’s Focused Inbox inference classification resource. This action cannot change classification settings or rules; manage message classification rules through the overrides collection.

Input Parameters

string
The user’s identifier. Use ‘me’ for the signed-in user, or provide the user’s ID or principal name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_MAILBOX_SETTINGSUpdates mailbox settings for the signed-in user or a specified user, including automatic replies, default time zone, language, and working hours.

Input Parameters

string
The user’s unique identifier or principal name. Use ‘me’ for the signed-in user.
object
Locale preferences for date/time formatting.
string
Default mailbox time zone (e.g., ‘Pacific Standard Time’).
object
Working hours configuration for the user.
object
Configuration for automatic replies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_MAIL_FOLDERTool to update the display name of a mail folder. Use when you need to rename an existing mail folder.

Input Parameters

string
Identifier for the user whose mailbox contains the folder. Use ‘me’ for the authenticated user or provide the user’s principal name or ID.
string
required
The new display name for the mail folder.
string
required
The unique identifier of the mail folder to update. This ID can be obtained from listing mail folders or creating a mail folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_MASTER_CATEGORYTool to update the color of a category in the user’s master category list. Use when you need to change the color of an existing category. Note that the display name cannot be modified after creation.

Input Parameters

string ("none" | "preset0" | "preset1" | "preset2" | "preset3" | "preset4" | "preset5" | "preset6" | "preset7" | "preset8" | "preset9" | "preset10" | "preset11" | "preset12" | "preset13" | "preset14" | "preset15" | "preset16" | "preset17" | "preset18" | "preset19" | "preset20" | "preset21" | "preset22" | "preset23" | "preset24")
required
A pre-set color constant for the category. This is the only writable property - displayName cannot be modified after creation. Allowed values: none, preset0 through preset24.
string
The user’s unique identifier or principal name. Use ‘me’ for the signed-in user.
string
required
The unique identifier of the outlookCategory to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_ME_CONTACTS_EXTENSIONSTool to update an open extension on a contact in a contact folder. Use when you need to modify custom properties stored in a contact extension.

Input Parameters

string
User’s identifier; ‘me’ for the signed-in user, or user’s principal name/ID.
string
required
The unique identifier of the contact to which the extension belongs.
string
required
The unique identifier of the extension to update. Can be the full extension ID (e.g., Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.ContactData) or just the extension name (e.g., Com.Contoso.ContactData).
string
required
The name of the extension. Must match the format: ‘Com.Company.ExtensionName’.
string
required
The unique identifier of the contact folder containing the contact.
object
Custom properties to update or add to the extension. Each property can be a string, number, or boolean value. If not provided, only the extension name will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_TODO_TASKUpdates an existing Microsoft To Do task’s title, status, importance, due date, reminder, body, completion date, or categories. Providing a reminder date also enables the reminder.

Input Parameters

object
Updated description or notes for the task. Provide both contentType (‘text’ or ‘html’) and content fields.
string
The new title of the task.
string
The updated status of the task. Allowed values: ‘notStarted’, ‘inProgress’, ‘completed’, ‘waitingOnOthers’, ‘deferred’.
string
required
The unique identifier of the task to update. Obtain this from List To Do tasks or Create To Do task.
string
User ID or userPrincipalName. Use ‘me’ for the signed-in user (delegated auth) or a specific user ID for app-only (S2S) authentication.
array
Updated list of category labels for the task.
string
The importance level of the task. Allowed values: ‘low’, ‘normal’, ‘high’.
object
The updated due date and time. Provide both dateTime (ISO 8601) and timeZone.
object
The updated reminder date and time. Setting this will also enable the reminder.
object
The date and time the task was completed. Typically set alongside status=‘completed’.
string
required
The unique identifier of the task list that contains the task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_USER_CALENDARUpdate the name or color of a user’s default calendar. At least one of these properties must be supplied.

Input Parameters

string
The new display name for the calendar. Note: The default calendar cannot be renamed in some configurations.
string ("auto" | "lightBlue" | "lightGreen" | "lightOrange" | "lightGray" | "lightYellow" | "lightTeal" | "lightPink" | "lightBrown" | "lightRed" | "maxColor")
Color theme options for calendars in Outlook.
string
required
The user ID or userPrincipalName of the user whose calendar to update. Use ‘me’ for the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_USER_CALENDAR_CALENDAR_EVENTUpdate an event in a specified user’s calendar by calendar ID and event ID. This tool is deprecated.

Input Parameters

object
Date, time, and timezone information.
object
Message content associated with the event.
object
Date, time, and timezone information.
string
Status to show: free, tentative, busy, oof, workingElsewhere, unknown.
string
Subject/title of the event.
string
required
The unique identifier or userPrincipalName of the user whose calendar contains the event to update.
string
required
The unique identifier of the event to update.
object
Location information for an event.
array
Array of attendee objects with email addresses and types.
array
Categories associated with the event.
string
The importance of the event: low, normal, or high.
boolean
Set to true if the event lasts all day.
object
Recurrence pattern for recurring events.
string
required
The unique identifier of the calendar containing the event.
string
Sensitivity level: normal, personal, private, confidential.
boolean
Set to true if an alert reminds the user of the event.
boolean
True if event has online meeting information.
integer
Minutes before event start when reminder alert occurs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_USER_CALENDAR_EVENTTool to update an event in a specific user’s calendar. Use when you need to modify calendar event properties for a user other than the signed-in user.

Input Parameters

object
Date, time, and timezone information.
object
Message content associated with the event.
object
Date, time, and timezone information.
string
Status to show: free, tentative, busy, oof, workingElsewhere, unknown.
string
Subject/title of the event.
string
required
The unique identifier or userPrincipalName of the user whose calendar event to update.
string
required
The unique identifier of the event to update.
boolean
Set to true if the event lasts all day.
object
Location information for an event.
array
Array of attendee objects with email addresses and types.
array
Categories associated with the event.
string
The importance of the event: low, normal, or high.
object
Recurrence pattern for recurring events.
string
Sensitivity level: normal, personal, private, confidential.
boolean
Set to true if an alert reminds the user of the event.
boolean
True if event has online meeting information.
integer
Minutes before event start when reminder alert occurs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_USER_CALENDAR_PERMISSIONTool to update calendar permission levels for a specific user’s calendar. Use when you need to change the access level (role) for someone who has been granted access to a user’s calendar.

Input Parameters

string ("none" | "freeBusyRead" | "limitedRead" | "read" | "write")
required
The permission level to change to for the calendar share recipient or delegate. Possible values: none (remove access), freeBusyRead (view free/busy status only), limitedRead (view free/busy status, titles and locations), read (view all details except private events), write (view all details except private events and edit events).
string
required
The user ID or principal name of the user whose calendar permission to update. Use ‘me’ for the authenticated user or provide a specific user ID/UPN.
string
The unique identifier of the calendar. If not provided, defaults to the user’s primary calendar.
string
required
The unique identifier of the calendar permission to update. This ID can be obtained from listing calendar permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_USER_CALENDARSTool to update properties of a specific calendar by ID for a specific user. Use when you need to rename a user’s calendar, change its color theme, or set it as the default calendar.

Input Parameters

string
The new display name for the calendar. Provide this to rename the calendar.
string ("auto" | "lightBlue" | "lightGreen" | "lightOrange" | "lightGray" | "lightYellow" | "lightTeal" | "lightPink" | "lightBrown" | "lightRed" | "maxColor")
Color theme options for calendars in Outlook.
string
required
The user ID or userPrincipalName of the user whose calendar to update. Use ‘me’ for the authenticated user.
string
required
The unique identifier of the calendar to update. This is the calendar ID returned when listing calendars.
boolean
Set to true to make this calendar the user’s default calendar, false otherwise. The default calendar is where new events are created by default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_USER_CHILD_FOLDER_MESSAGETool to update a message in a child folder within a user’s mailbox. Use when you need to modify message properties such as isRead status, importance, categories, or subject for messages in nested folder structures for a specific user.

Input Parameters

object
The body of the message.
object
The flag value that indicates the status, start date, due date, or completion date for the message.
object
Represents information about a user in the sending or receiving end of a message.
boolean
Whether the message has been read.
object
Represents information about a user in the sending or receiving end of a message.
array
The email addresses to use when replying. Only updatable if isDraft=true.
string
The subject of the message.
string
required
The unique identifier of the user whose mailbox contains the message.
array
The categories associated with the message.
string ("low" | "normal" | "high")
Importance level of the message.
string
required
The unique identifier of the message to update.
array
The Cc recipients for the message.
array
The To recipients for the message.
array
The Bcc recipients for the message.
string
required
The unique identifier of the parent mail folder containing the child folder.
string
required
The unique identifier of the child folder containing the message to update.
string
The message ID in RFC2822 format. Only updatable if isDraft=true.
boolean
Whether a read receipt is requested for the message.
string ("focused" | "other")
Classification of the message based on inferred relevance or importance.
boolean
Whether a delivery receipt is requested for the message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_USER_CONTACT_EXTENSIONTool to update an open extension on a contact in a user’s contact folder. Use when you need to modify custom properties stored in a contact extension for a specific user.

Input Parameters

string
required
The unique identifier of the user. Can be user ID or userPrincipalName.
string
required
The unique identifier of the contact.
string
required
The unique identifier of the extension. Can be extension name (e.g., ‘Com.Contoso.Referral’) or fully qualified name (e.g., ‘Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.Referral’).
string
required
The name of the extension. Must match the format: ‘Com.Company.ExtensionName’.
string
required
The unique identifier of the contact folder containing the contact.
object
Custom properties to update in the extension. Each property can be a string, number, or boolean value. For M365 resources like contacts, only specified properties are updated (unspecified ones remain unchanged). If not provided, only the extension name will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_USER_CONTACTS_EXTENSIONSUpdates an open extension on a contact in a child folder of a user’s contact folder, including its custom properties.

Input Parameters

string
required
The unique identifier of the user. Can be ‘me’ for the authenticated user, the user’s email address, or the user’s object ID.
string
required
The unique identifier of the contact to which the extension belongs.
string
required
The unique identifier of the extension to update. Can be the full extension ID (e.g., Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.ContactData) or just the extension name (e.g., Com.Contoso.ContactData).
string
required
The name of the extension. Must match the format: ‘Com.Company.ExtensionName’.
string
required
The unique identifier of the child folder within the contact folder.
string
required
The unique identifier of the contact folder containing the contact.
object
Custom properties to update or add to the extension. Each property can be a string, number, or boolean value. If not provided, only the extension name will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_USER_CONTACTS_EXTENSIONS_DIRECTTool to update an open extension on a contact directly under a user’s contacts collection. Use when you need to modify custom properties stored in a contact extension.

Input Parameters

string
The unique identifier of the user. Can be ‘me’ for the authenticated user, the user’s email address, or the user’s object ID.
string
required
The unique identifier of the contact to which the extension belongs.
string
required
The unique identifier of the extension to update. Can be the full extension ID (e.g., Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.TestExtension) or just the extension name (e.g., Com.Contoso.TestExtension).
string
required
The name of the extension. Must match the format: ‘Com.Company.ExtensionName’.
object
Custom properties to update or add to the extension. Each property can be a string, number, or boolean value. If not provided, only the extension name will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_USER_EVENT_EXTENSIONUpdate an open extension on a user’s event in a calendar group, including its extension name and optional custom properties. This tool is deprecated.

Input Parameters

string
required
The unique identifier of the user whose calendar event contains the extension to update. Can be the user’s principal name (email address) or object ID.
string
required
The unique identifier of the calendar event containing the extension to update.
string
required
The unique identifier of the calendar within the calendar group.
string
required
The unique identifier of the extension to update. Can be the full extension ID (e.g., Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.TestExtension) or just the extension name (e.g., Com.Contoso.TestExtension).
string
required
The name of the extension. Must match the format: ‘Com.Company.ExtensionName’.
string
required
The unique identifier of the calendar group containing the calendar.
object
Custom properties to update in the extension. Each property can be a string, number, or boolean value. If not provided, only the extension name will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_USER_EVENTS_EXTENSIONSTool to update an open extension on a user’s calendar event. Use when modifying custom properties stored in an event extension for a specific user.

Input Parameters

string
required
The unique identifier of the user whose event extension should be updated. Can be the user’s principal name (email address), object ID, or ‘me’ for the authenticated user.
string
required
The unique identifier of the calendar event containing the extension to update.
string
required
The unique identifier of the extension to update. Can be the full extension ID (e.g., Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.TestExtension) or just the extension name (e.g., Com.Contoso.TestExtension).
string
required
The name of the extension. Must match the format: ‘Com.Company.ExtensionName’.
object
Custom properties to update in the extension. Each property can be a string, number, or boolean value. If not provided, only the extension name will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_USER_INFERENCE_CLASSIFICATION_OVERRIDETool to update the classification of messages from a specific sender in a user’s Focused Inbox. Use when you need to change whether messages from a sender go to Focused or Other inbox for a specific user.

Input Parameters

string
required
The user ID or ‘me’ for the authenticated user
string ("focused" | "other")
required
Specifies how incoming messages from a specific sender should always be classified. Use ‘focused’ to prioritize messages in the Focused inbox, or ‘other’ to send them to the Other inbox.
string
required
The unique identifier of the inference classification override to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_USER_MAIL_FOLDER_MESSAGETool to update properties of a message in a specific mail folder for a user. Use when you need to modify message attributes like categories, read status, importance, or other properties for a message within a particular user’s folder.

Input Parameters

object
The body of the message.
object
The flag value that indicates the status, start date, due date, or completion date for the message.
object
Represents information about a user in the sending or receiving end of a message.
boolean
Whether the message has been read.
object
Represents information about a user in the sending or receiving end of a message.
array
The email addresses to use when replying. Only updatable if isDraft=true.
string
The subject of the message. Only updatable if isDraft=true.
string
required
The unique identifier of the user whose mailbox contains the message. Use ‘me’ for the authenticated user or a specific user ID.
array
The categories associated with the message. Use this to organize and filter messages.
string ("low" | "normal" | "high")
Importance level of the message.
string
required
The unique identifier of the message to update within the specified mail folder.
array
The Cc recipients for the message.
array
The To recipients for the message.
array
The Bcc recipients for the message.
string
required
The unique identifier of the mail folder containing the message. Use ‘inbox’, ‘drafts’, ‘sentitems’, or a custom folder ID.
string
The message ID in RFC2822 format. Only updatable if isDraft=true.
boolean
Whether a read receipt is requested for the message.
string ("focused" | "other")
Classification of the message based on inferred relevance or importance.
boolean
Whether a delivery receipt is requested for the message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_USER_MAIL_FOLDER_MESSAGE_EXTENSIONTool to update an open extension on a message within a specific user’s mail folder. Use when you need to modify custom properties stored in a message extension for a specific user.

Input Parameters

string
required
The unique identifier of the user or ‘me’ for the authenticated user. Can be a user principal name (UPN) or user ID.
string
required
The unique identifier of the message containing the extension to update.
string
required
The unique identifier or name of the extension to update. Can be the full extension ID (e.g., ‘Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.TestExtension’) or just the extension name (e.g., ‘Com.Contoso.TestExtension’).
string
The name of the extension. If provided, it will update the extension name. Must follow the format ‘Com.Company.ExtensionName’.
string
required
The unique identifier of the mail folder containing the message. Can be a well-known folder name (e.g., ‘inbox’, ‘drafts’, ‘sentitems’) or a folder ID.
object
Custom properties to update in the extension. Each property can be a string, number, or boolean value. If not provided, only the extension name (if specified) will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_USER_MAIL_FOLDER_MESSAGE_RULETool to update a message rule in a user’s mail folder. Use when you need to modify an existing rule’s properties, conditions, actions, or exceptions for a specific user.

Input Parameters

object
Updated actions to take when the rule conditions are met.
string
required
The ID of the message rule to update.
string
User’s identifier; ‘me’ for the signed-in user, or user’s principal name/ID.
integer
Updated order in which the rule is executed (lower numbers execute first).
object
Updated conditions that must be met for the rule to apply.
object
Updated exception conditions for the rule.
boolean
Whether the rule should be enabled or disabled.
string
Updated display name for the message rule.
string
required
The ID of the mail folder containing the message rule. Can be a well-known folder name (e.g., ‘inbox’, ‘drafts’, ‘sentitems’) or a folder ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_USER_MAIL_FOLDERS_CHILD_FOLDERSTool to update a child folder within a mail folder for a specific user. Use when you need to rename a child mail folder.

Input Parameters

string
required
The unique identifier of the user. Use ‘me’ for the authenticated user or the user’s ID/userPrincipalName.
string
The mailFolder’s display name to update.
string
required
The unique identifier of the parent mail folder.
string
required
The unique identifier of the child folder to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_UPDATE_USER_MESSAGE_EXTENSIONTool to update an open extension on a user’s message. Use when you need to modify custom properties stored in a message extension for a specific user.

Input Parameters

string
required
The unique identifier of the user or ‘me’ for the authenticated user. Can be a user principal name (UPN) or user ID.
string
required
The unique identifier of the message containing the extension to update.
string
required
The unique identifier or name of the extension to update. Can be the full extension ID (e.g., ‘Microsoft.OutlookServices.OpenTypeExtension.Com.Contoso.TestExtension’) or just the extension name (e.g., ‘Com.Contoso.TestExtension’).
string
The name of the extension. If provided, it will update the extension name. Must follow the format ‘Com.Company.ExtensionName’.
object
Custom properties to update in the extension. Each property can be a string, number, or boolean value. If not provided, only the extension name (if specified) will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OUTLOOK_WHO_AM_IReturn the identity (email, name) of the connected Outlook account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not

Triggers

Slug: OUTLOOK_CONTACT_TRIGGERType: webhookTriggered when a new contact is added in the Outlook contacts.

Payload

string
required
Type of event
string
required
The unique identifier for the message
Slug: OUTLOOK_EVENT_CHANGE_TRIGGERType: webhookTriggered when a new calendar event occurs (created, updated, or deleted) in the Outlook calendar.

Payload

string
required
Type of event
string
required
The unique identifier for the message
Slug: OUTLOOK_EVENT_TRIGGERType: webhookTriggered when a new calendar event is created in the Outlook calendar.

Payload

string
required
Type of event
string
required
The unique identifier for the message
Slug: OUTLOOK_MESSAGE_TRIGGERType: webhookTriggered when a new message is received in the Outlook mailbox.Watches the Inbox by default. Set folder_id to watch a different mail folder, and from_email, to_email, subject_contains or has_attachments to fire only for the messages you care about.

Configuration

string
Outlook mail folder to watch. Defaults to inbox when unset. Accepts a well-known folder name (inbox, sentitems, drafts, deleteditems, junkemail, outbox, archive) or a folder ID. Use OUTLOOK_LIST_MAIL_FOLDERS to discover top-level folder IDs and OUTLOOK_LIST_CHILD_MAIL_FOLDERS for nested folders. Shared and delegated mailbox folders are not supported.
string
Only fire for messages sent from this address. Case-insensitive. Matched against the message’s From address, falling back to its Sender address for send-on-behalf-of mail.
boolean
Only fire for messages that do (true) or do not (false) have attachments. Note that Outlook counts an inline image as an attachment.
string ("low" | "normal" | "high")
Only fire for messages with this importance level.
string
Only fire when the message subject contains this text. Case-insensitive. Matched as given, so leading and trailing whitespace is significant.
string
Only fire for messages addressed to this address on the To line. Case-insensitive. Cc and Bcc recipients are not matched.

Payload

string
required
Type of event
string
required
The unique identifier for the message
object
Deprecated Outlook message field. Use outlook_message instead.
object
Outlook message fields supplied with this event, when available. The full body is not included. To retrieve the full message or when this field is absent, call OUTLOOK_GET_MESSAGE with this event’s id.
Slug: OUTLOOK_SENT_MESSAGE_TRIGGERType: webhookTriggered when a new message is sent from the Outlook mailbox.Watches Sent Items by default. Set folder_id to watch a different mail folder, and from_email, to_email, subject_contains or has_attachments to fire only for the messages you care about.

Configuration

string
Outlook mail folder to watch. Defaults to sentitems when unset. Accepts a well-known folder name (inbox, sentitems, drafts, deleteditems, junkemail, outbox, archive) or a folder ID. Use OUTLOOK_LIST_MAIL_FOLDERS to discover top-level folder IDs and OUTLOOK_LIST_CHILD_MAIL_FOLDERS for nested folders. Shared and delegated mailbox folders are not supported.
string
Only fire for messages sent from this address. Case-insensitive. Matched against the message’s From address, falling back to its Sender address for send-on-behalf-of mail.
boolean
Only fire for messages that do (true) or do not (false) have attachments. Note that Outlook counts an inline image as an attachment.
string ("low" | "normal" | "high")
Only fire for messages with this importance level.
string
Only fire when the message subject contains this text. Case-insensitive. Matched as given, so leading and trailing whitespace is significant.
string
Only fire for messages addressed to this address on the To line. Case-insensitive. Cc and Bcc recipients are not matched.

Payload

string
required
Type of event
string
required
The unique identifier for the message
object
Deprecated Outlook message field. Use outlook_message instead.
object
Outlook message fields supplied with this event, when available. The full body is not included. To retrieve the full message or when this field is absent, call OUTLOOK_GET_MESSAGE with this event’s id.