Outlook
Overview
Section titled “Overview”Outlook is Microsoft’s email and calendaring platform integrating contacts, scheduling, and communication in a unified workspace. With the SquadOS integration, your agents can send emails, create and update calendar events, manage contacts, move messages between folders, and create tasks in Microsoft To Do — all via the Microsoft Graph API.
- Official website: https://outlook.microsoft.com/
- Composio documentation: docs.composio.dev/toolkits/outlook
Authentication
Section titled “Authentication”This tool uses OAuth 2.0 (OAUTH2) to connect. It also supports S2S_OAUTH2 for server-to-server (application) authentication in production contexts with application permissions.
You will need to authorize access to your Microsoft account. The OAuth flow is managed by Composio.
How to get credentials
Section titled “How to get credentials”- Visit https://composio.dev/auth/outlook for a step-by-step guide on creating and configuring custom OAuth credentials for Microsoft Outlook.
- Sign in with your Microsoft account and authorize the requested scopes.
- For S2S (application permissions), register an app in the Azure Portal and configure the required API scopes.
How to connect in SquadOS
Section titled “How to connect in SquadOS”- Go to Tools in the side menu (
/admin/tools). - Open the Available tab and search for
Outlook. - Click the card to open the details and hit Connect.
- You’re taken to the secure connection page hosted by Composio, where you authorize access to your Microsoft account via OAuth.
- Once done, you’re sent back to SquadOS with the account connected and the tool available for your agents. (Connection-flow details in Organization Tools.)
How do I set up custom OAuth credentials for Microsoft (Outlook)?
Section titled “How do I set up custom OAuth credentials for Microsoft (Outlook)?”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).
Why does the Outlook new message trigger only return a message ID?
Section titled “Why does the Outlook new message trigger only return a message ID?”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.
Why doesn’t OUTLOOK_SEND_EMAIL return message details?
Section titled “Why doesn’t OUTLOOK_SEND_EMAIL return message details?”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.
What’s the @odata.context URL?
Section titled “What’s the @odata.context URL?”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.
Available actions
Section titled “Available actions”Send email
Section titled “Send email”OUTLOOK_SEND_EMAIL
Sends an email with subject, body, recipients, and optional attachments via Microsoft Graph API. Supports comma-separated email addresses in the to field for multiple recipients. Accepts either a single file or a list of files as attachments.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
to | string | Yes | The primary recipient’s email address(es). You can provide a single email or multiple emails separated by commas. |
body | string | Yes | The content of the email body as a plain string (plain text or HTML based on is_html). |
subject | string | Yes | The subject line of the email. |
is_html | boolean | No | Specifies if the email body is HTML; true for HTML, false for plain text. |
to_name | string | No | The display name of the primary recipient. |
user_id | string | No | The user’s email address or the alias me to represent the authenticated user. |
cc_emails | array | No | List of email addresses for CC recipients. |
bcc_emails | array | No | List of email addresses for BCC recipients. |
attachment | string | No | File(s) to attach. Accepts a single file or a list of files. |
from_address | string | No | Optional From address to set on the message (send as/on behalf). Requires appropriate mailbox permissions. |
save_to_sent_items | boolean | No | Indicates if the email should be saved in ‘Sent Items’. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create email draft
Section titled “Create email draft”OUTLOOK_CREATE_DRAFT
Creates a new Outlook email draft with subject, body, recipients, and an optional attachment. For creating a draft reply to an existing conversation, use OUTLOOK_CREATE_DRAFT_REPLY instead.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
body | string | Yes | Content of the email draft; use is_html to specify if HTML or plain text. |
subject | string | Yes | Subject line for the email draft. |
is_html | boolean | No | Specifies if body is HTML. If false, body is plain text. |
to_recipients | array | No | Optional list of primary ‘To’ recipient email addresses as an array of strings. |
cc_recipients | array | No | Optional list of CC recipient email addresses. |
bcc_recipients | array | No | Optional list of BCC recipient email addresses. |
attachment | string | No | Optional file(s) to attach to the draft. |
user_id | string | No | User ID (GUID) or user principal name for S2S authentication. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Send draft
Section titled “Send draft”OUTLOOK_SEND_DRAFT
Sends an existing draft message. Use after creating a draft when you want to deliver it to recipients immediately.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
message_id | string | Yes | The unique identifier of the draft message to send. |
user_id | string | No | The user’s email address or me to represent the authenticated user. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Reply to email
Section titled “Reply to email”OUTLOOK_REPLY_EMAIL
Sends a reply to an Outlook email message with optional HTML formatting, identified by message_id, allowing optional CC and BCC recipients.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
message_id | string | Yes | The Microsoft Graph message ID (Base64-encoded string starting with AAMk). Obtain from OUTLOOK_LIST_MESSAGES or OUTLOOK_GET_MESSAGE. |
comment | string | Yes | The body content of the reply email. Can be plain text or HTML based on is_html. |
is_html | boolean | No | Whether the comment body should be rendered as HTML. |
user_id | string | No | The user’s email address or me for the authenticated user. |
cc_emails | array | No | List of email addresses for CC recipients. |
bcc_emails | array | No | List of email addresses for BCC recipients. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Forward message
Section titled “Forward message”OUTLOOK_FORWARD_MESSAGE
Forwards a message to new recipients.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
message_id | string | Yes | The unique identifier of the message to forward (Base64-encoded string, e.g., AAMkAGI2TAAA=). |
to_recipients | array | Yes | List of email addresses to forward the message to. |
comment | string | No | An optional comment to include with the forwarded message. |
user_id | string | No | The user’s email address or me for the authenticated user. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List messages
Section titled “List messages”OUTLOOK_LIST_MESSAGES
Retrieves a list of email messages from a specified mail folder, with options for filtering, pagination, and sorting. Supports conversationId filtering to retrieve all messages in a thread.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
folder | string | No | ID or well-known name of the mail folder (e.g., inbox, sentitems, drafts, deleteditems). |
top | integer | No | Maximum number of messages to return per request (1–1000). Check @odata.nextLink for pagination. |
filter | string | No | OData filter expression to filter messages. |
select | array | No | Message properties to include in the response. |
orderby | array | No | Properties to sort results by. |
user_id | string | No | Target user’s email or me for the authenticated user. |
is_read | boolean | No | Filter by read status: true for read, false for unread. |
subject | string | No | Filter by exact match of the subject line. |
from_address | string | No | Filter by the sender’s exact email address. |
received_date_time_ge | string | No | Filter messages received on or after this ISO 8601 timestamp. |
received_date_time_lt | string | No | Filter messages received before this ISO 8601 timestamp. |
response_detail | string | No | Level of detail: minimal (default, no body) or full (full payload including HTML). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get email message
Section titled “Get email message”OUTLOOK_GET_MESSAGE
Retrieves a specific email message by its ID from the specified user’s Outlook mailbox.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
message_id | string | Yes | Unique ID of the Outlook email message to retrieve. |
select | array | No | List of message properties to include in the response. |
user_id | string | No | User’s email address, UPN, or me for the authenticated user. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Search Outlook messages
Section titled “Search Outlook messages”OUTLOOK_SEARCH_MESSAGES
Search Outlook messages using powerful KQL syntax. Supports sender (from:), recipient (to:, cc:), subject, date filters, attachments, and boolean logic. Only works with Microsoft 365/Enterprise accounts (no @hotmail.com/@outlook.com).
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
query | string | No | KQL search query string (e.g., from:user@example.com AND received>=2025-10-01, subject:invoice AND hasattachment:yes). |
user_id | string | No | Target mailbox: me for the signed-in user, or an email/UPN for a shared/other mailbox. |
size | integer | No | Number of search results per page (1–25). |
from_index | integer | No | 0-based starting index for pagination (max 999). |
subject | string | No | Text to search within the message subject (legacy parameter; prefer using subject:text in query). |
fromEmail | string | No | Filter by sender email or domain (legacy parameter). |
hasAttachments | boolean | No | Filter messages by attachment presence (legacy parameter). |
enable_top_results | boolean | No | If true, sorts results by relevance; otherwise, sorts by date descending. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Query emails
Section titled “Query emails”OUTLOOK_QUERY_EMAILS
Query Outlook emails within a SINGLE folder using OData filters. Best for structured queries on message metadata within a specific folder. Returns up to 100 messages per request with pagination support.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
folder | string | No | Single mail folder to search within (e.g., inbox, sentitems). For cross-folder search, use OUTLOOK_SEARCH_MESSAGES. |
filter | string | No | OData $filter query string (e.g., isRead eq false, receivedDateTime ge 2025-01-01T00:00:00Z). |
top | integer | No | Maximum number of messages to return per request (1–1000). Default: 100. |
select | array | No | List of message properties to include in the response. |
orderby | string | No | Sort order as comma-separated string (e.g., receivedDateTime desc). |
user_id | string | No | Target user’s email or me for the authenticated user. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Move message to folder
Section titled “Move message to folder”OUTLOOK_MOVE_MESSAGE
Move a message to another folder within the user’s mailbox. Creates a new copy in the destination folder and removes the original. The message_id changes after a successful move.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
message_id | string | Yes | Unique ID of the Outlook email message to move. |
destination_id | string | Yes | The destination folder ID, or a well-known folder name (e.g., inbox, deleteditems, drafts). |
user_id | string | No | User’s email address, UPN, or me for the authenticated user. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List mail folders
Section titled “List mail folders”OUTLOOK_LIST_MAIL_FOLDERS
Lists the user’s top-level mail folders. Use to discover folder IDs before moving, filtering, or organizing messages.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
user_id | string | No | User’s id, userPrincipalName, or me for the signed-in user. |
top | integer | No | Maximum number of items to return per page. |
include_hidden_folders | boolean | No | Include hidden mail folders when true. |
filter | string | No | OData filter expression to filter mail folders. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Download Outlook attachment
Section titled “Download Outlook attachment”OUTLOOK_DOWNLOAD_OUTLOOK_ATTACHMENT
Downloads a specific file attachment from an email message. The returned data.file.s3url is temporary — download the file immediately after calling this tool.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
message_id | string | Yes | The unique identifier of the email message containing the attachment. |
attachment_id | string | Yes | The Microsoft Graph API attachment identifier (Base64-encoded opaque string from OUTLOOK_LIST_OUTLOOK_ATTACHMENTS). |
file_name | string | Yes | The desired filename for the downloaded attachment. |
user_id | string | No | The user’s UPN or me for the authenticated user. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get mailbox settings
Section titled “Get mailbox settings”OUTLOOK_GET_MAILBOX_SETTINGS
Retrieves mailbox settings such as automatic replies, time zone, and working hours for the signed-in or specified user.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
user_id | string | No | The user’s unique identifier or principal name. Use me for the signed-in user. |
select | array | No | OData $select query to specify mailbox settings properties. Valid properties: archiveFolder, automaticRepliesSetting, dateFormat, language, timeFormat, timeZone, userPurpose, workingHours. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create calendar event
Section titled “Create calendar event”OUTLOOK_CALENDAR_CREATE_EVENT
Creates a new Outlook calendar event, ensuring start_datetime is chronologically before end_datetime.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
subject | string | Yes | The subject of the calendar event. |
start_datetime | string | Yes | The start date and time of the event in ISO 8601 format. |
end_datetime | string | Yes | The end date and time of the event in ISO 8601 format. |
time_zone | string | Yes | The time zone for the start and end times (e.g., Pacific Standard Time or America/Los_Angeles). |
body | string | No | The body of the event in plain text or HTML format. |
is_html | boolean | No | Specifies whether the body content is HTML. |
location | string | No | The physical location of the event. |
attendees_info | array | No | A list of attendees. Accepts email strings or objects with email, name, and type fields. |
calendar_id | string | No | The ID of a specific calendar. If omitted, the event is created on the user’s default calendar. |
is_online_meeting | boolean | No | Set to true to indicate an online meeting (generates a Teams link if online_meeting_provider is set). |
online_meeting_provider | string | No | The online meeting provider. Currently only teamsForBusiness is supported. |
user_id | string | No | The user identifier for the calendar owner. Use me or a Microsoft 365 UPN. |
importance | string | No | The importance of the event: low, normal, or high. |
show_as | string | No | The status to show on the calendar: free, tentative, busy, oof, workingElsewhere. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List calendar events
Section titled “List calendar events”OUTLOOK_LIST_EVENTS
Retrieves events from a user’s Outlook calendar via Microsoft Graph API. Supports primary, secondary, and shared calendars, pagination, filtering, property selection, sorting, and timezone specification.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
user_id | string | No | Email address of the target user or me for the authenticated user. |
calendar_id | string | No | Optional ID of a specific calendar. If not provided, uses the default calendar. |
filter | string | No | OData query string to filter calendar events. Use start/dateTime and end/dateTime for date filtering. |
top | integer | No | Maximum number of events to retrieve per page. |
select | array | No | List of specific event property names to return. |
orderby | array | No | List of properties to sort results by. |
timezone | string | No | Preferred timezone for event start/end times (IANA or Windows format). |
expand_recurring_events | boolean | No | When true, expands recurring events to show actual occurrences within the filtered date range. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Update calendar event
Section titled “Update calendar event”OUTLOOK_UPDATE_CALENDAR_EVENT
Updates specified fields of an existing Outlook calendar event. Fetches the existing event, merges only the provided fields, and PATCHes the merged updates. Unspecified fields remain unchanged.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
event_id | string | Yes | The unique identifier of the calendar event to be updated. |
subject | string | No | New subject for the event. |
start_datetime | string | No | New start date and time for the event. |
end_datetime | string | No | New end date and time for the event. |
time_zone | string | No | Time zone for start_datetime and/or end_datetime. |
location | string | No | Event location. |
attendees | array | No | Attendee list. If provided, replaces the existing attendees. |
body | object | No | Event body with content type (Text or HTML) and the content. |
show_as | string | No | Availability status: free, tentative, busy, oof. |
user_id | string | No | The user identifier. Use me for the authenticated user. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Accept calendar event invite
Section titled “Accept calendar event invite”OUTLOOK_ACCEPT_EVENT
Accepts or tentatively accepts a calendar meeting invite on behalf of a user. The organizer will receive a notification unless send_response is set to false.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
event_id | string | Yes | The unique identifier of the calendar event to respond to. |
response_type | string | No | Type of response: accept to accept, tentative to tentatively accept. |
send_response | boolean | No | Whether to send the response to the organizer. |
comment | string | No | Optional text message to include with the response. |
user_id | string | No | The user ID or userPrincipalName of the calendar owner. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Decline calendar event
Section titled “Decline calendar event”OUTLOOK_DECLINE_EVENT
Declines an invitation to a calendar event. The API returns 202 Accepted with no content on success.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
event_id | string | Yes | The unique identifier of the calendar event to decline. |
comment | string | No | Optional text message to include in the response to the organizer. |
sendResponse | boolean | No | If true, a decline response is sent to the organizer. Default: true. |
user_id | string | No | The user’s primary SMTP address, UPN, or me for the signed-in user. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List Outlook calendars
Section titled “List Outlook calendars”OUTLOOK_LIST_CALENDARS
Lists calendars in the signed-in user’s mailbox.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
user_id | string | No | User ID or userPrincipalName. Use me for the signed-in user. |
top | integer | No | Maximum number of calendars to return. |
filter | string | No | OData filter expression. |
select | array | No | Properties to include in the response. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Find meeting times
Section titled “Find meeting times”OUTLOOK_FIND_MEETING_TIMES
Suggests meeting times based on organizer and attendee availability, time constraints, and duration requirements.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
attendees | array | No | List of attendees or resources for the meeting. |
meetingDuration | string | No | Meeting length in ISO 8601 duration format (e.g., PT1H for 1 hour, PT30M for 30 minutes). Default: 30 minutes. |
timeConstraint | object | No | Time restrictions for the meeting. |
maxCandidates | integer | No | Maximum number of meeting time suggestions to return. |
isOrganizerOptional | boolean | No | If true, organizer doesn’t need to attend. |
user_id | string | No | User ID or User Principal Name. Use me for the authenticated user. |
prefer_timezone | string | No | Preferred timezone for the response. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get schedule
Section titled “Get schedule”OUTLOOK_GET_SCHEDULE
Retrieves free/busy schedule information for specified email addresses within a defined time window. Read-only; does not reserve time or prevent conflicts.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
schedules | array | Yes | A list of SMTP email addresses (max 20) whose schedules are to be retrieved. |
startTime | object | Yes | The start date, time, and time zone. Object must include dateTime (ISO 8601) and timeZone. |
endTime | object | Yes | The end date, time, and time zone. The period can be up to 62 days. |
availabilityViewInterval | string | No | Duration of each time slot in minutes (min: 5, max: 1440). Default: 30. |
userId | string | No | The user ID or principal name. Required for S2S authentication. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create contact
Section titled “Create contact”OUTLOOK_CREATE_CONTACT
Creates a new contact in a Microsoft Outlook user’s contacts folder.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
givenName | string | No | The contact’s given (first) name. |
surname | string | No | The contact’s surname (last name). |
displayName | string | No | The contact’s display name, typically their full name. |
emailAddresses | array | No | A list of email addresses. Each item must be an object with an address field and optionally a name field. |
mobilePhone | string | No | The contact’s mobile phone number. |
businessPhones | array | No | A list of business phone numbers. |
jobTitle | string | No | The contact’s job title. |
companyName | string | No | The name of the company the contact is associated with. |
notes | string | No | Personal notes about the contact. |
userId | string | No | Identifier for the user. Use me for the authenticated user. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create To Do task
Section titled “Create To Do task”OUTLOOK_CREATE_TASK
Creates a new task in Microsoft To Do within a specified task list.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
title | string | Yes | The title of the task. |
todo_task_list_id | string | Yes | The unique identifier of the task list where the task will be created. Use OUTLOOK_LIST_TO_DO_LISTS to retrieve available list IDs. |
importance | string | No | The importance level: low, normal, or high. Defaults to normal. |
dueDateTime | object | No | Date/time with timezone information for the task due date. |
reminderDateTime | object | No | Date/time with timezone information for the task reminder. |
body | object | No | Task body content with content type. |
categories | array | No | A list of category labels to organize the task. |
user_id | string | No | User ID or userPrincipalName. Use me for the signed-in user. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List To Do task lists
Section titled “List To Do task lists”OUTLOOK_LIST_TO_DO_LISTS
Lists Microsoft To Do task lists for the signed-in user. Use to discover available task lists before listing or creating tasks.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
user_id | string | No | User ID or userPrincipalName. Use me for the signed-in user. |
top | integer | No | Maximum number of task lists to return. |
filter | string | No | OData filter expression to filter task lists. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Get Outlook profile
Section titled “Get Outlook profile”OUTLOOK_GET_PROFILE
Retrieves the Microsoft Outlook profile for a specified user.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
user_id | string | No | The user’s unique identifier or principal name. Use me to get the profile of the authenticated user. |
include_proxy_addresses | boolean | No | Whether to include proxy addresses in the response. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Delete message
Section titled “Delete message”OUTLOOK_DELETE_MESSAGE
Permanently deletes an Outlook email message by its message_id. Use when removing unwanted messages, cleaning up drafts, or performing mailbox maintenance.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
message_id | string | Yes | Unique identifier of the message to delete. |
user_id | string | No | The UPN or ID of the user; use me for the signed-in user. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Update email message
Section titled “Update email message”OUTLOOK_UPDATE_EMAIL
Updates specified properties of an existing email message.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
message_id | string | Yes | The unique identifier of the email message to be updated. |
subject | string | No | New subject line. If omitted, the existing subject remains unchanged. |
is_read | boolean | No | Mark message as read (true) or unread (false). |
body | object | No | New body content. Must include contentType (Text or HTML) and content. |
importance | string | No | New importance level (low, normal, high). |
categories | array | No | Categories associated with the message. |
to_recipients | array | No | List of TO recipients; replaces all existing TOs. |
cc_recipients | array | No | List of CC recipients; replaces all existing CCs. |
user_id | string | No | The UPN of the user or me for the authenticated user. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |