Outlook
outlookOutlook is Microsoft's email and calendaring platform integrating contacts and scheduling, enabling users to manage communications and events in a unified workspace
Acciones disponibles (43)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add mail attachmentOUTLOOK_ADD_MAIL_ATTACHMENTAcciónTool to add an attachment to an email message. use when you have a message id and need to attach a small (<3 mb) file or reference.
OUTLOOK_ADD_MAIL_ATTACHMENTAcciónTool to add an attachment to an email message. use when you have a message id and need to attach a small (<3 mb) file or reference.
Parámetros de entrada
itemobjectEmbedded item (e.g., message, event) for itemAttachment; must include its own '@odata.type'.
namestringObligatorioDisplay name of the attachment (e.g., file name).
user_idstringThe user's principal name or 'me' for the authenticated user.
isInlinebooleanSet to true if the attachment should appear inline in the message body.
contentIdstringContent ID for inline attachments, used in HTML body references.
message_idstringObligatorioUnique identifier of the email message to attach to.
odata_typestringObligatorioThe OData type of the attachment. For file attachments, use '#microsoft.graph.fileAttachment'.
contentTypestringMIME type of the attachment (e.g., 'application/pdf').
contentBytesanyObligatoriobyteBase64-encoded content of the file attachment (max size 3 MB).
contentLocationstringURL location or path for reference attachments.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create calendarOUTLOOK_CREATE_CALENDARAcciónTool to create a new calendar in the signed-in user's mailbox. use when organizing events into a separate calendar.
OUTLOOK_CREATE_CALENDARAcciónTool to create a new calendar in the signed-in user's mailbox. use when organizing events into a separate calendar.
Parámetros de entrada
namestringObligatorioThe display name of the new calendar.
colorstringenumThe theme color to assign to the calendar. Supported values: auto, lightBlue, lightGreen, lightOrange, lightGray, lightYellow, lightTeal, lightPink, lightBrown, lightPurple, lightRed.
autolightBluelightGreenlightOrangelightGraylightYellowlightTeallightPinklightBrownlightPurplelightReduser_idstringThe UPN (User Principal Name) or object ID of the user where the calendar will be created. Use 'me' for the signed-in user.
hexColorstringAn optional hexadecimal color code for the calendar in the format '#RRGGBB'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create contact folderOUTLOOK_CREATE_CONTACT_FOLDERAcciónTool to create a new contact folder in the user's mailbox. use when needing to organize contacts into custom folders.
OUTLOOK_CREATE_CONTACT_FOLDERAcciónTool to create a new contact folder in the user's mailbox. use when needing to organize contacts into custom folders.
Parámetros de entrada
user_idstringThe user's principal name or object ID. Use 'me' for the authenticated user.
displayNamestringObligatorioThe display name of the new contact folder.
parentFolderIdstringThe ID of the parent contact folder. If omitted, created under the default contacts folder.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Email RuleOUTLOOK_CREATE_EMAIL_RULEAcciónCreate email rule filter with conditions and actions
OUTLOOK_CREATE_EMAIL_RULEAcciónCreate email rule filter with conditions and actions
Parámetros de entrada
actionsobjectObligatorioActions to take when the rule conditions are met.
sequenceintegerOrder in which the rule is executed (lower numbers execute first).
isEnabledbooleanWhether the rule is enabled.
conditionsobjectObligatorioConditions that must be met for the rule to apply.
displayNamestringObligatorioDisplay name for the email rule.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create mail folderOUTLOOK_CREATE_MAIL_FOLDERAcciónTool to create a new mail folder. use when you need to organize email into a new folder.
OUTLOOK_CREATE_MAIL_FOLDERAcciónTool to create a new mail folder. use when you need to organize email into a new folder.
Parámetros de entrada
user_idstringIdentifier 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.
isHiddenbooleanIndicates whether the new folder is hidden. Default is false. Once set, this property cannot be updated.
displayNamestringObligatorioThe display name of the new mail folder.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create master categoryOUTLOOK_CREATE_MASTER_CATEGORYAcciónTool to create a new category in the user's master category list. use after selecting a unique display name.
OUTLOOK_CREATE_MASTER_CATEGORYAcciónTool to create a new category in the user's master category list. use after selecting a unique display name.
Parámetros de entrada
colorstringenumA pre-set color constant for the category. Allowed values: preset0 through preset24.
preset0preset1preset2preset3preset4preset5preset6preset7preset8preset9preset10preset11+13displayNamestringObligatorioUnique name that identifies the category in the user's mailbox.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete mail folderOUTLOOK_DELETE_MAIL_FOLDERAcciónDelete a mail folder from the user's mailbox. use when you need to remove an existing mail folder.
OUTLOOK_DELETE_MAIL_FOLDERAcciónDelete a mail folder from the user's mailbox. use when you need to remove an existing mail folder.
Parámetros de entrada
user_idstringIdentifier 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.
folder_idstringObligatorioThe unique identifier or well-known name of the mail folder to delete (e.g., folder ID or 'Drafts', 'SentItems').
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Download Outlook attachmentOUTLOOK_DOWNLOAD_OUTLOOK_ATTACHMENTAcciónDownloads 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.
OUTLOOK_DOWNLOAD_OUTLOOK_ATTACHMENTAcciónDownloads 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.
Parámetros de entrada
user_idstringThe user's UPN (User Principal Name) or 'me' for the authenticated user. This identifies the mailbox where the message is located.
file_namestringObligatorioThe desired filename for the downloaded attachment. This name will be assigned to the `FileDownloadable` object.
message_idstringObligatorioThe unique identifier of the email message that contains the attachment to be downloaded. This ID is typically obtained when listing or retrieving messages.
attachment_idstringObligatorioThe unique identifier of the attachment to be downloaded. This ID is typically obtained from the message's details when an email message object is retrieved.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get mailbox settingsOUTLOOK_GET_MAILBOX_SETTINGSAcciónTool 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.
OUTLOOK_GET_MAILBOX_SETTINGSAcciónTool 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.
Parámetros de entrada
expandstring[]OData $expand query to include related entities.
selectstring[]OData $select query to specify mailbox settings properties to include.
user_idstringThe user's unique identifier or principal name. Use 'me' for the signed-in user.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get mail deltaOUTLOOK_GET_MAIL_DELTAAcciónTool to retrieve incremental changes (delta) of messages in a mailbox. use when syncing mailbox updates since last checkpoint.
OUTLOOK_GET_MAIL_DELTAAcciónTool to retrieve incremental changes (delta) of messages in a mailbox. use when syncing mailbox updates since last checkpoint.
Parámetros de entrada
topintegerMaximum number of items to return per page.
skipintegerNumber of items to skip for pagination.
countbooleanInclude count of total items in the response.
expandstring[]List of related entities to expand (e.g. ['attachments']).
filterstringOData filter string to filter messages (e.g. 'isRead eq false').
searchstringSearch phrase to filter messages (e.g. 'project update').
selectstring[]List of message properties to include (e.g. ['subject','receivedDateTime']).
orderbystring[]List of properties to sort by with direction (e.g. ['receivedDateTime desc']).
user_idstringUser identifier: 'me' for the signed-in user or the user's email/UPN.
folder_idstringMail folder identifier to scope the delta query to that folder (e.g., 'Inbox' or folder ID GUID).
skip_tokenstringSkip token for paging through large result sets.
delta_tokenstringDelta token from a previous call to get only changes since that state.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get mail tipsOUTLOOK_GET_MAIL_TIPSAcciónTool to retrieve mail tips such as automatic replies and mailbox full status. use when you need to check recipient status before sending mail.
OUTLOOK_GET_MAIL_TIPSAcciónTool to retrieve mail tips such as automatic replies and mailbox full status. use when you need to check recipient status before sending mail.
Parámetros de entrada
user_idstringUser principal name (UPN) or 'me' for the signed-in user.
EmailAddressesstring[]ObligatorioCollection of SMTP addresses of recipients to get MailTips for.
MailTipsOptionsstring[]ObligatorioList of mail tip types to retrieve for each recipient.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get master categoriesOUTLOOK_GET_MASTER_CATEGORIESAcciónTool to retrieve the user's master category list. use when you need to get all categories defined for the user.
OUTLOOK_GET_MASTER_CATEGORIESAcciónTool to retrieve the user's master category list. use when you need to get all categories defined for the user.
Parámetros de entrada
topintegerMaximum number of master categories to return (OData $top).
skipintegerNumber of master categories to skip for pagination (OData $skip).
filterstringOData $filter query to filter master categories.
selectstring[]OData $select query to specify properties to include.
orderbystring[]OData $orderby query to order master categories by property values.
user_idstringThe user's unique identifier or principal name. Use 'me' for the signed-in user.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get supported languagesOUTLOOK_GET_SUPPORTED_LANGUAGESAcciónTool to retrieve supported languages in the user's mailbox. use when you need to display or select from available mailbox languages.
OUTLOOK_GET_SUPPORTED_LANGUAGESAcciónTool to retrieve supported languages in the user's mailbox. use when you need to display or select from available mailbox languages.
Parámetros de entrada
user_idstringThe user's unique identifier or principal name. Use 'me' for the signed-in user.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get supported time zonesOUTLOOK_GET_SUPPORTED_TIME_ZONESAcciónTool to retrieve supported time zones in the user's mailbox. use when you need a list of time zones to display or choose from for event scheduling.
OUTLOOK_GET_SUPPORTED_TIME_ZONESAcciónTool to retrieve supported time zones in the user's mailbox. use when you need a list of time zones to display or choose from for event scheduling.
Parámetros de entrada
timeZoneStandardstringenumSpecifies the time zone format to return. Supported values: 'Windows' or 'Iana'. Default is 'Windows' if not specified.
WindowsIana
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Outlook calendarsOUTLOOK_LIST_CALENDARSAcciónTool to list calendars in the signed-in user's mailbox. use when you need to retrieve calendars with optional odata queries.
OUTLOOK_LIST_CALENDARSAcciónTool to list calendars in the signed-in user's mailbox. use when you need to retrieve calendars with optional odata queries.
Parámetros de entrada
topintegerMaximum number of calendars to return (OData $top).
skipintegerNumber of calendars to skip (OData $skip).
filterstringOData filter expression (OData $filter).
selectstring[]Properties to include (OData $select).
orderbystring[]Order by expressions (OData $orderby).
user_idstringUser ID or userPrincipalName. Use 'me' for the signed-in user.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List event attachmentsOUTLOOK_LIST_EVENT_ATTACHMENTSAcciónTool to list attachments for a specific outlook calendar event. use when you have an event id and need to view its attachments.
OUTLOOK_LIST_EVENT_ATTACHMENTSAcciónTool to list attachments for a specific outlook calendar event. use when you have an event id and need to view its attachments.
Parámetros de entrada
topintegerMaximum number of attachments to return (OData $top).
skipintegerNumber of attachments to skip (OData $skip).
filterstringOData filter string to filter the attachments (OData $filter).
selectstring[]List of attachment properties to include (OData $select).
orderbystring[]Order by clauses to sort the results (OData $orderby).
user_idstringThe user's primary SMTP address, UPN, or 'me' for the signed-in user.
event_idstringObligatorioThe unique identifier of the calendar event to retrieve attachments for.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Outlook attachmentsOUTLOOK_LIST_OUTLOOK_ATTACHMENTSAcciónLists metadata (like name, size, and type, but not `contentbytes`) for all attachments of a specified outlook email message.
OUTLOOK_LIST_OUTLOOK_ATTACHMENTSAcciónLists metadata (like name, size, and type, but not `contentbytes`) for all attachments of a specified outlook email message.
Parámetros de entrada
user_idstringThe 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.
message_idstringObligatorioThe unique identifier of the email message from which to retrieve attachments. This ID is specific to the Outlook message.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List event remindersOUTLOOK_LIST_REMINDERSAcciónTool to retrieve reminders for events occurring within a specified time range. use when you need to see upcoming reminders between two datetimes.
OUTLOOK_LIST_REMINDERSAcciónTool to retrieve reminders for events occurring within a specified time range. use when you need to see upcoming reminders between two datetimes.
Parámetros de entrada
userIdstringUser Principal Name or ID. Use 'me' to indicate the signed-in user.
endDateTimestringObligatorioThe end date and time in ISO 8601 format defining the window for reminders. Example: '2023-10-26T20:00:00.0000000'.
startDateTimestringObligatorioThe start date and time in ISO 8601 format defining the window for reminders. Example: '2023-10-26T19:00:00.0000000'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add event attachmentOUTLOOK_OUTLOOK_ADD_EVENT_ATTACHMENTAcciónAdds an attachment to a specific outlook calendar event. use when you need to attach a file or nested item to an existing event.
OUTLOOK_OUTLOOK_ADD_EVENT_ATTACHMENTAcciónAdds an attachment to a specific outlook calendar event. use when you need to attach a file or nested item to an existing event.
Parámetros de entrada
itemobjectThe nested item payload; required when '@odata.type' is itemAttachment.
namestringObligatorioThe display name of the attachment.
user_idstringThe user's email address or 'me' for the authenticated user.
event_idstringObligatorioThe unique identifier of the calendar event to which the attachment will be added.
odata_typestringObligatorioenumAttachment type: '#microsoft.graph.fileAttachment' requires 'contentBytes'; '#microsoft.graph.itemAttachment' requires 'item'.
#microsoft.graph.fileAttachment#microsoft.graph.itemAttachmentcontentBytesstringBase64-encoded file contents; required when '@odata.type' is fileAttachment.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Calendar EventOUTLOOK_OUTLOOK_CALENDAR_CREATE_EVENTAcciónCreates a new outlook calendar event, ensuring `start datetime` is chronologically before `end datetime`.
OUTLOOK_OUTLOOK_CALENDAR_CREATE_EVENTAcciónCreates a new outlook calendar event, ensuring `start datetime` is chronologically before `end datetime`.
Parámetros de entrada
bodystringObligatorioThe body of the event. This can be in plain text or HTML format, as specified by the 'is_html' field.
is_htmlbooleanSpecifies whether the 'body' content is HTML. Set to true for HTML content; otherwise, it's treated as plain text.
show_asstringThe status to show on the calendar for the duration of the event. Valid values are: 'free', 'tentative', 'busy', 'oof' (out of office), 'workingElsewhere', 'unknown'.
subjectstringObligatorioThe subject of the calendar event.
user_idstringThe UPN (User Principal Name) or object ID of the user whose calendar the event will be created in. Use 'me' for the currently authenticated user.
locationstringThe physical location of the event.
time_zonestringObligatorioThe 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.
categoriesstring[]A list of categories associated with the event. These categories must already exist in the user's mailbox.
end_datetimestringObligatoriodate-timeThe end date and time of the event in ISO 8601 format. Time zone is specified in 'time_zone'.
attendees_infoobject[]A list of attendees for the event. Each attendee object requires an 'email'. 'name' and 'type' ('required', 'optional', 'resource') are optional.
start_datetimestringObligatoriodate-timeThe start date and time of the event in ISO 8601 format. Time zone is specified in 'time_zone'.
is_online_meetingbooleanSet 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).
online_meeting_providerstringSpecifies 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.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create contactOUTLOOK_OUTLOOK_CREATE_CONTACTAcciónCreates a new contact in a microsoft outlook user's contacts folder.
OUTLOOK_OUTLOOK_CREATE_CONTACTAcciónCreates a new contact in a microsoft outlook user's contacts folder.
Parámetros de entrada
notesstringPersonal notes about the contact. These notes are stored as 'personalNotes' in the Outlook contact details.
surnamestringThe contact's surname (last name).
user_idstringIdentifier for the user whose contact list will be modified. Use 'me' for the authenticated user, or provide the user's principal name (e.g., 'user@example.com').
birthdaystringThe 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).
jobTitlestringThe contact's job title.
givenNamestringThe contact's given (first) name.
homePhonestringThe contact's home phone number. If provided, this will be stored in Outlook as a list containing this single number.
categoriesstring[]A list of categories to assign to the contact.
departmentstringThe department the contact belongs to within their company.
companyNamestringThe name of the company the contact is associated with.
displayNamestringThe contact's display name, typically their full name.
mobilePhonestringThe contact's mobile phone number.
businessPhonesstring[]A list of business phone numbers for the contact. Each number should be a string.
emailAddressesobject[]A list of email addresses for the contact.
officeLocationstringThe contact's office location.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create email draftOUTLOOK_OUTLOOK_CREATE_DRAFTAcciónCreates an outlook email draft with subject, body, recipients, and an optional attachment. supports creating drafts as part of existing conversation threads by specifying a conversationid; attachments require a name, mimetype, and content.
OUTLOOK_OUTLOOK_CREATE_DRAFTAcciónCreates an outlook email draft with subject, body, recipients, and an optional attachment. supports creating drafts as part of existing conversation threads by specifying a conversationid; attachments require a name, mimetype, and content.
Parámetros de entrada
bodystringObligatorioContent of the email draft; use `is_html` to specify if HTML or plain text.
is_htmlbooleanSpecifies if the `body` is HTML. If `False`, `body` is plain text.
subjectstringObligatorioSubject line for the email draft.
attachmentobjectOptional file to attach. If provided, must include the file's content, name, and mimetype.
cc_recipientsstring[]Optional list of CC (carbon copy) recipient email addresses.
to_recipientsstring[]ObligatorioList of primary 'To' recipient email addresses.
bcc_recipientsstring[]Optional list of BCC (blind carbon copy) recipient email addresses.
conversation_idstringOptional conversation ID to create the draft as part of an existing email conversation thread. If provided, the draft will be part of the specified conversation instead of starting a new one.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create a draft replyOUTLOOK_OUTLOOK_CREATE_DRAFT_REPLYAcciónCreates 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.
OUTLOOK_OUTLOOK_CREATE_DRAFT_REPLYAcciónCreates 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.
Parámetros de entrada
commentstringPlain text comment to include in the body of the reply draft.
user_idstringUser's mailbox identifier (email or 'me') for the original message and new draft location.
cc_emailsstring[]List of email addresses to add as CC recipients to the draft reply.
bcc_emailsstring[]List of email addresses to add as BCC recipients to the draft reply.
message_idstringObligatorioUnique ID of the message to reply to, typically obtained from actions like 'List Messages' or 'Get Message'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ContactOUTLOOK_OUTLOOK_DELETE_CONTACTAcciónPermanently 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`.
OUTLOOK_OUTLOOK_DELETE_CONTACTAcciónPermanently 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`.
Parámetros de entrada
user_idstringThe UPN (User Principal Name) or ID of the user; use 'me' for the signed-in user.
contact_idstringObligatorioIdentifier of the contact to be deleted, typically obtained from 'List User Contacts' or 'Get Contact'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Calendar EventOUTLOOK_OUTLOOK_DELETE_EVENTAcciónDeletes an existing calendar event, identified by its unique `event id`, from a specified user's microsoft outlook calendar, with an option to send cancellation notifications to attendees.
OUTLOOK_OUTLOOK_DELETE_EVENTAcciónDeletes an existing calendar event, identified by its unique `event id`, from a specified user's microsoft outlook calendar, with an option to send cancellation notifications to attendees.
Parámetros de entrada
user_idstringUser's email address or 'me' for the current user.
event_idstringObligatorioUnique identifier of the calendar event to delete, typically obtained from event listing or retrieval actions.
send_notificationsbooleanIf `True`, sends cancellation notifications to event attendees upon deletion.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get contactOUTLOOK_OUTLOOK_GET_CONTACTAcciónRetrieves a specific outlook contact by its `contact id` from the contacts of a specified `user id` (defaults to 'me' for the authenticated user).
OUTLOOK_OUTLOOK_GET_CONTACTAcciónRetrieves a specific outlook contact by its `contact id` from the contacts of a specified `user id` (defaults to 'me' for the authenticated user).
Parámetros de entrada
user_idstringUser'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.
contact_idstringObligatorioUnique identifier for the contact within the specified user's Outlook address book.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get contact foldersOUTLOOK_OUTLOOK_GET_CONTACT_FOLDERSAcciónTool to retrieve a list of contact folders in the signed-in user's mailbox. use after authentication when you need to browse or select among contact folders.
OUTLOOK_OUTLOOK_GET_CONTACT_FOLDERSAcciónTool to retrieve a list of contact folders in the signed-in user's mailbox. use after authentication when you need to browse or select among contact folders.
Parámetros de entrada
topintegerMaximum number of contact folders to return.
skipintegerNumber of contact folders to skip for pagination.
expandstring[]Related entities to expand inline, e.g., ['contacts'].
filterstringOData filter expression, e.g., startswith(displayName,'A').
selectstring[]List of properties to include in the response, e.g., ['id','displayName'].
orderbystring[]List of properties to order results by, e.g., ['displayName asc'].
user_idstringUser principal name or ID. Use 'me' for the authenticated user.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get calendar eventOUTLOOK_OUTLOOK_GET_EVENTAcciónRetrieves the full details of a specific calendar event by its id from a user's outlook calendar, provided the event exists.
OUTLOOK_OUTLOOK_GET_EVENTAcciónRetrieves the full details of a specific calendar event by its id from a user's outlook calendar, provided the event exists.
Parámetros de entrada
user_idstringThe user's primary SMTP address, user principal name (UPN), or the alias 'me' (for the signed-in user) to identify the calendar owner.
event_idstringObligatorioThe unique identifier of the calendar event to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get email messageOUTLOOK_OUTLOOK_GET_MESSAGEAcciónRetrieves a specific email message by its id from the specified user's outlook mailbox. use the 'select' parameter to include specific fields like 'internetmessageheaders' for filtering automated emails.
OUTLOOK_OUTLOOK_GET_MESSAGEAcciónRetrieves a specific email message by its id from the specified user's outlook mailbox. use the 'select' parameter to include specific fields like 'internetmessageheaders' for filtering automated emails.
Parámetros de entrada
selectstringComma-separated list of properties to include. Use 'internetMessageHeaders' to get email headers for filtering automated messages.
user_idstringUser's email address, UPN, or 'me' for the currently authenticated user.
message_idstringObligatorioUnique ID of the Outlook email message to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Outlook profileOUTLOOK_OUTLOOK_GET_PROFILEAcciónRetrieves the microsoft outlook profile for a specified user.
OUTLOOK_OUTLOOK_GET_PROFILEAcciónRetrieves the microsoft outlook profile for a specified user.
Parámetros de entrada
user_idstringThe user's unique identifier or principal name. Use 'me' to get the profile of the authenticated user.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get scheduleOUTLOOK_OUTLOOK_GET_SCHEDULEAcciónRetrieves free/busy schedule information for specified email addresses within a defined time window.
OUTLOOK_OUTLOOK_GET_SCHEDULEAcciónRetrieves free/busy schedule information for specified email addresses within a defined time window.
Parámetros de entrada
EndTimeobjectObligatorioThe end date, time, and time zone for the period for which to retrieve schedules. The period can be up to 62 days.
Schedulesstring[]ObligatorioA list of SMTP email addresses for users, distribution lists, or resources whose schedules are to be retrieved. Maximum of 20 addresses.
StartTimeobjectObligatorioThe start date, time, and time zone for the period for which to retrieve schedules.
availabilityViewIntervalstringThe duration of each time slot in the availability view, specified in minutes. Minimum: 5, Maximum: 1440. Default: 30.
Parámetros de salida
dataobjectA dictionary containing the raw response from the Microsoft Graph API. This typically includes a 'value' key, which is a list of schedule information objects. Each object corresponds to a requested schedule and contains details like 'scheduleId' (the email address), 'availabilityView' (a string indicating free/busy status for time slots), 'scheduleItems' (a list of calendar items), and 'workingHours'.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Outlook contactsOUTLOOK_OUTLOOK_LIST_CONTACTSAcciónRetrieves a user's microsoft outlook contacts, from the default or a specified contact folder.
OUTLOOK_OUTLOOK_LIST_CONTACTSAcciónRetrieves a user's microsoft outlook contacts, from the default or a specified contact folder.
Parámetros de entrada
topintegerMaximum number of contacts to retrieve.
filterstringOData V4 filter expression for targeted retrieval.
selectstring[]List of specific contact properties to retrieve. Each item is a property name. MUST be provided as a list. If empty, a default set of properties is returned.
orderbystring[]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.
user_idstringUser Principal Name (UPN) or ID of the user. 'me' refers to the authenticated user.
contact_folder_idstringID of a specific contact folder. If omitted, contacts are retrieved from the default contact folder.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List eventsOUTLOOK_OUTLOOK_LIST_EVENTSAcciónRetrieves events from a user's outlook calendar via microsoft graph api, supporting pagination, filtering, property selection, sorting, and timezone specification.
OUTLOOK_OUTLOOK_LIST_EVENTSAcciónRetrieves events from a user's outlook calendar via microsoft graph api, supporting pagination, filtering, property selection, sorting, and timezone specification.
Parámetros de entrada
topintegerMaximum number of events to retrieve per page for pagination.
skipintegerNumber of initial events to bypass, used for pagination.
filterstringOData query string to filter events (e.g., "start/dateTime ge 'YYYY-MM-DDTHH:MM:SSZ'"); string literals use single quotes.
selectstring[]List of specific event property names to return. Each item is a property name like 'subject' or 'start'. MUST be provided as a list. If omitted, a default set of properties is returned.
orderbystring[]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.
user_idstringEmail address of the target user (or 'me' for authenticated user), identifying the calendar for event listing.
timezonestringPreferred IANA or Windows timezone for event start/end times (e.g., 'America/New_York'); defaults to UTC if unspecified/invalid.
expand_recurring_eventsbooleanWhen 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.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List mail foldersOUTLOOK_OUTLOOK_LIST_MAIL_FOLDERSAcciónTool to list a user's top-level mail folders. use when you need folders like inbox, drafts, sent items; set include hidden folders=true to include hidden folders.
OUTLOOK_OUTLOOK_LIST_MAIL_FOLDERSAcciónTool to list a user's top-level mail folders. use when you need folders like inbox, drafts, sent items; set include hidden folders=true to include hidden folders.
Parámetros de entrada
user_idstringUser's id, userPrincipalName, or 'me' for the signed-in user.
include_hidden_foldersbooleanInclude hidden mail folders (isHidden=true) when set to true.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List MessagesOUTLOOK_OUTLOOK_LIST_MESSAGESAcciónRetrieves a list of email messages from a specified mail folder in an outlook mailbox, with options for filtering (including by conversationid to get all messages in a thread), pagination, and sorting; ensure 'user id' and 'folder' are valid, and all date/time strings are in iso 8601 format.
OUTLOOK_OUTLOOK_LIST_MESSAGESAcciónRetrieves a list of email messages from a specified mail folder in an outlook mailbox, with options for filtering (including by conversationid to get all messages in a thread), pagination, and sorting; ensure 'user id' and 'folder' are valid, and all date/time strings are in iso 8601 format.
Parámetros de entrada
topintegerMaximum number of messages to return (1-1000).
skipintegerNumber of messages to skip from the beginning of the result set, for pagination.
folderstringID or well-known name of the mail folder (e.g., 'Inbox', 'SentItems', 'Drafts', 'DeletedItems').
selectstring[]List of message properties to include. Each item is a property name like 'subject', 'from', or 'receivedDateTime'. MUST be provided as a list. Reduces data transfer.
is_readbooleanFilter by read status: 'true' for read, 'false' for unread. Unspecified means no filter by read status.
orderbystring[]List of properties to sort results by, with direction. Each item is a string like 'receivedDateTime desc' or 'subject asc'. MUST be provided as a list, even for single sort criteria.
subjectstringFilter by exact match of the subject line.
user_idstringTarget user's email or 'me' for authenticated user. For delegated access, use shared mailbox or delegated user's email.
categoriesstring[]Filter by categories (case-sensitive); matches if tagged with any specified category.
importancestringFilter by importance: 'low', 'normal', or 'high'.
from_addressstringFilter by the sender's exact email address.
conversationIdstringFilter messages by conversation ID to retrieve all messages in a specific email thread.
has_attachmentsbooleanFilter by attachment presence: 'true' for messages with attachments, 'false' for those without.
subject_containsstringFilter messages where the subject contains the specified case-insensitive substring.
subject_endswithstringFilter messages where the subject ends with the specified case-insensitive string.
sent_date_time_gtstringFilter messages sent after this ISO 8601 timestamp.
sent_date_time_ltstringFilter messages sent before this ISO 8601 timestamp.
subject_startswithstringFilter messages where the subject starts with the specified case-insensitive string.
received_date_time_gestringFilter messages received on or after this ISO 8601 timestamp.
received_date_time_gtstringFilter messages received after this ISO 8601 timestamp (e.g., '2023-01-01T00:00:00Z').
received_date_time_lestringFilter messages received on or before this ISO 8601 timestamp.
received_date_time_ltstringFilter messages received before this ISO 8601 timestamp.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Move message to folderOUTLOOK_OUTLOOK_MOVE_MESSAGEAcciónMove a message to another folder within the specified user's mailbox. this creates a new copy of the message in the destination folder and removes the original message.
OUTLOOK_OUTLOOK_MOVE_MESSAGEAcciónMove a message to another folder within the specified user's mailbox. this creates a new copy of the message in the destination folder and removes the original message.
Parámetros de entrada
user_idstringUser's email address, UPN, or 'me' for the currently authenticated user.
message_idstringObligatorioUnique ID of the Outlook email message to move.
destination_idstringObligatorioThe destination folder ID, or a well-known folder name (e.g., 'inbox', 'deleteditems', 'drafts', 'sentitems').
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Reply to EmailOUTLOOK_OUTLOOK_REPLY_EMAILAcciónSends a plain text reply to an outlook email message, identified by `message id`, allowing optional cc and bcc recipients.
OUTLOOK_OUTLOOK_REPLY_EMAILAcciónSends a plain text reply to an outlook email message, identified by `message id`, allowing optional cc and bcc recipients.
Parámetros de entrada
commentstringObligatorioThe plain text body of the reply email.
user_idstringThe user's email address or 'me' to indicate the authenticated user. This specifies the mailbox from which the reply will be sent.
cc_emailsstring[]List of email addresses for CC recipients.
bcc_emailsstring[]List of email addresses for BCC recipients.
message_idstringObligatorioThe unique ID of the message to reply to. This ID can be obtained from the `OUTLOOK_LIST_MESSAGES` action.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search Outlook messagesOUTLOOK_OUTLOOK_SEARCH_MESSAGESAcciónSearches messages in a microsoft 365 or enterprise outlook account mailbox, supporting filters for sender, subject, attachments, pagination, and sorting by relevance or date.
OUTLOOK_OUTLOOK_SEARCH_MESSAGESAcciónSearches messages in a microsoft 365 or enterprise outlook account mailbox, supporting filters for sender, subject, attachments, pagination, and sorting by relevance or date.
Parámetros de entrada
sizeintegerThe maximum number of search results to return in a single response for pagination.
querystringObligatorioThe free-text search string. Can include terms from the message body, attachments, sender, subject, or other properties.
subjectstringText to search for within the message subject line.
fromEmailstringThe sender's email address to filter messages; only Microsoft 365/Enterprise domains are supported.
from_indexintegerThe 0-based starting index for the returned search results for pagination.
hasAttachmentsbooleanFilters messages based on the presence of attachments.
enable_top_resultsbooleanIf `true`, sorts results by relevance; otherwise, sorts by date in descending order (newest first).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Send emailOUTLOOK_OUTLOOK_SEND_EMAILAcciónSends an email with subject, body, recipients, and an optional attachment via microsoft graph api; attachments require a non-empty file with valid name and mimetype.
OUTLOOK_OUTLOOK_SEND_EMAILAcciónSends an email with subject, body, recipients, and an optional attachment via microsoft graph api; attachments require a non-empty file with valid name and mimetype.
Parámetros de entrada
bodystringObligatorioThe content of the email body, plain text or HTML based on `is_html`.
is_htmlbooleanSpecifies if the email body is HTML; `True` for HTML, `False` for plain text.
subjectstringObligatorioThe subject line of the email.
to_namestringThe display name of the primary recipient.
user_idstringThe user's email address or the alias 'me' to represent the authenticated user.
to_emailstringObligatorioThe primary recipient's email address.
cc_emailsstring[]List of email addresses for CC recipients.
attachmentobjectOptional file to attach. If provided, its name, mimetype, and content must be valid and non-empty.
bcc_emailsstring[]List of email addresses for BCC recipients.
save_to_sent_itemsbooleanIndicates if the email should be saved in 'Sent Items'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update calendar eventOUTLOOK_OUTLOOK_UPDATE_CALENDAR_EVENTAcciónUpdates specified fields of an existing outlook calendar event.
OUTLOOK_OUTLOOK_UPDATE_CALENDAR_EVENTAcciónUpdates specified fields of an existing outlook calendar event.
Parámetros de entrada
bodyobjectThe body of the event, specifying content type ('Text' or 'HTML') and the content itself.
show_asstringThe availability status to show for the event. Valid values: 'free', 'tentative', 'busy', 'oof' (out of office).
subjectstringThe new subject for the event. If explicitly set to an empty string, the event's subject will be cleared.
user_idstringThe 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.
event_idstringObligatorioThe unique identifier of the calendar event to be updated. This ID can be obtained from the OUTLOOK_LIST_EVENTS action.
locationobjectThe location of the event, represented as a dictionary.
attendeesobject[]A list of attendees for the event. Providing this list (even if empty) will replace all existing attendees on the event.
time_zonestringThe time zone for the `start_datetime` and `end_datetime` of the event. Uses IANA time zone database names (e.g., 'America/Los_Angeles', 'UTC').
categoriesstring[]A list of categories to associate with the event. Providing this list (even if empty) will replace all existing categories of the event.
end_datetimestringdate-timeThe new end date and time for the event. Expects a datetime object or an ISO 8601 formatted string. Must be chronologically after `start_datetime`. The time zone for this datetime is specified by the `time_zone` field.
start_datetimestringdate-timeThe new start date and time for the event. Expects a datetime object or an ISO 8601 formatted string. The time zone for this datetime is specified by the `time_zone` field.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ContactOUTLOOK_OUTLOOK_UPDATE_CONTACTAcciónUpdates an existing outlook contact, identified by `contact id` for the specified `user id`, requiring at least one other field to be modified.
OUTLOOK_OUTLOOK_UPDATE_CONTACTAcciónUpdates an existing outlook contact, identified by `contact id` for the specified `user id`, requiring at least one other field to be modified.
Parámetros de entrada
notesstringPersonal notes about the contact (maps to 'personalNotes' in Microsoft Graph API).
surnamestringContact's surname (last name).
user_idstringUser's identifier; 'me' for the signed-in user, or user's principal name/ID.
birthdaystringContact's birthday (YYYY-MM-DD format).
jobTitlestringContact's job title.
givenNamestringContact's given (first) name.
categoriesstring[]Categories for organizing the contact.
contact_idstringObligatorioUnique identifier of the contact to update.
departmentstringContact's department.
homePhonesstring[]Contact's home phone numbers.
companyNamestringContact's company name.
displayNamestringContact's full display name.
mobilePhonestringContact's mobile phone number.
businessPhonesstring[]Contact's business phone numbers.
emailAddressesobject[]Contact's email addresses.
officeLocationstringContact's office location.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update email messageOUTLOOK_OUTLOOK_UPDATE_EMAILAcciónUpdates specified properties of an existing email message; `message id` must identify a valid message within the specified `user id`'s mailbox.
OUTLOOK_OUTLOOK_UPDATE_EMAILAcciónUpdates specified properties of an existing email message; `message id` must identify a valid message within the specified `user id`'s mailbox.
Parámetros de entrada
bodyobjectNew body content (Text or HTML). If omitted, the existing message body remains unchanged.
subjectstringNew subject. Omitting or providing an empty string clears the subject. To preserve the current subject, provide its existing value.
user_idstringThe 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.
importancestringNew importance level ('low', 'normal', 'high'). If omitted, importance is set to 'normal'.
message_idstringObligatorioThe unique identifier of the email message to be updated. This ID is typically obtained from listing messages or creating/sending a message.
cc_recipientsobject[]List of CC recipients; replaces all existing CCs. Omitting this field removes all current CC recipients.
to_recipientsobject[]List of TO recipients; replaces all existing TOs. Omitting this field removes all current TO recipients.
bcc_recipientsobject[]List of BCC recipients; replaces all existing BCCs. Omitting this field removes all current BCC recipients.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update mailbox settingsOUTLOOK_UPDATE_MAILBOX_SETTINGSAcciónTool to update mailbox settings for the signed-in user. use when you need to configure automatic replies, default time zone, language, or working hours. example: schedule automatic replies for vacation.
OUTLOOK_UPDATE_MAILBOX_SETTINGSAcciónTool to update mailbox settings for the signed-in user. use when you need to configure automatic replies, default time zone, language, or working hours. example: schedule automatic replies for vacation.
Parámetros de entrada
languageobjectLocale preferences for date/time formatting.
timeZonestringDefault mailbox time zone (e.g., 'Pacific Standard Time').
workingHoursobjectWorking hours configuration for the user.
automaticRepliesSettingobjectConfiguration for automatic replies.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Triggers (5)
Los triggers son eventos externos que pueden iniciar un flujo en tus agentes (ej: nuevo email, mensaje recibido, registro creado).
New Contact AddedOUTLOOK_CONTACT_TRIGGERTriggerTriggered when a new contact is added in the Outlook contacts.
OUTLOOK_CONTACT_TRIGGERTriggerTriggered when a new contact is added in the Outlook contacts.
Configuración
Sin parámetros.
Payload del evento
event_typestringObligatorioType of event
idstringObligatorioThe unique identifier for the message
Calendar Event ChangesOUTLOOK_EVENT_CHANGE_TRIGGERTriggerTriggered when a new calendar event occurs (created, updated, or deleted) in the Outlook calendar.
OUTLOOK_EVENT_CHANGE_TRIGGERTriggerTriggered when a new calendar event occurs (created, updated, or deleted) in the Outlook calendar.
Configuración
Sin parámetros.
Payload del evento
event_typestringObligatorioType of event
idstringObligatorioThe unique identifier for the message
New Calendar EventOUTLOOK_EVENT_TRIGGERTriggerTriggered when a new calendar event is created in the Outlook calendar.
OUTLOOK_EVENT_TRIGGERTriggerTriggered when a new calendar event is created in the Outlook calendar.
Configuración
Sin parámetros.
Payload del evento
event_typestringObligatorioType of event
idstringObligatorioThe unique identifier for the message
New Outlook MessageOUTLOOK_MESSAGE_TRIGGERTriggerTriggered when a new message is received in the Outlook mailbox.
OUTLOOK_MESSAGE_TRIGGERTriggerTriggered when a new message is received in the Outlook mailbox.
Configuración
Sin parámetros.
Payload del evento
event_typestringObligatorioType of event
idstringObligatorioThe unique identifier for the message
New Sent MessageOUTLOOK_SENT_MESSAGE_TRIGGERTriggerTriggered when a new message is sent from the Outlook mailbox.
OUTLOOK_SENT_MESSAGE_TRIGGERTriggerTriggered when a new message is sent from the Outlook mailbox.
Configuración
Sin parámetros.
Payload del evento
event_typestringObligatorioType of event
idstringObligatorioThe unique identifier for the message