Outlook

outlook

Outlook is Microsoft's email and calendaring platform integrating contacts and scheduling, enabling users to manage communications and events in a unified workspace

Email Calendar Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Sí

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

Tool 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

itemobject
Embedded item (e.g., message, event) for itemAttachment; must include its own '@odata.type'.
namestringObligatorio
Display name of the attachment (e.g., file name).
user_idstring
The user's principal name or 'me' for the authenticated user.
isInlineboolean
Set to true if the attachment should appear inline in the message body.
contentIdstring
Content ID for inline attachments, used in HTML body references.
message_idstringObligatorio
Unique identifier of the email message to attach to.
odata_typestringObligatorio
The OData type of the attachment. For file attachments, use '#microsoft.graph.fileAttachment'.
contentTypestring
MIME type of the attachment (e.g., 'application/pdf').
contentBytesanyObligatoriobyte
Base64-encoded content of the file attachment (max size 3 MB).
contentLocationstring
URL location or path for reference attachments.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create calendarOUTLOOK_CREATE_CALENDARAcción

Tool to create a new calendar in the signed-in user's mailbox. use when organizing events into a separate calendar.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create contact folderOUTLOOK_CREATE_CONTACT_FOLDERAcción

Tool 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_idstring
The user's principal name or object ID. Use 'me' for the authenticated user.
displayNamestringObligatorio
The display name of the new contact folder.
parentFolderIdstring
The ID of the parent contact folder. If omitted, created under the default contacts folder.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Email RuleOUTLOOK_CREATE_EMAIL_RULEAcción

Create email rule filter with conditions and actions

Parámetros de entrada

actionsobjectObligatorio
Actions to take when the rule conditions are met.
sequenceinteger
Order in which the rule is executed (lower numbers execute first).
isEnabledboolean
Whether the rule is enabled.
conditionsobjectObligatorio
Conditions that must be met for the rule to apply.
displayNamestringObligatorio
Display name for the email rule.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create mail folderOUTLOOK_CREATE_MAIL_FOLDERAcción

Tool to create a new mail folder. use when you need to organize email into a new folder.

Parámetros de entrada

user_idstring
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.
isHiddenboolean
Indicates whether the new folder is hidden. Default is false. Once set, this property cannot be updated.
displayNamestringObligatorio
The display name of the new mail folder.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create master categoryOUTLOOK_CREATE_MASTER_CATEGORYAcción

Tool to create a new category in the user's master category list. use after selecting a unique display name.

Parámetros de entrada

colorstringenum
A pre-set color constant for the category. Allowed values: preset0 through preset24.
preset0preset1preset2preset3preset4preset5preset6preset7preset8preset9preset10preset11+13
displayNamestringObligatorio
Unique name that identifies the category in the user's mailbox.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete mail folderOUTLOOK_DELETE_MAIL_FOLDERAcción

Delete a mail folder from the user's mailbox. use when you need to remove an existing mail folder.

Parámetros de entrada

user_idstring
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.
folder_idstringObligatorio
The unique identifier or well-known name of the mail folder to delete (e.g., folder ID or 'Drafts', 'SentItems').

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Download Outlook attachmentOUTLOOK_DOWNLOAD_OUTLOOK_ATTACHMENTAcción

Downloads 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_idstring
The user's UPN (User Principal Name) or 'me' for the authenticated user. This identifies the mailbox where the message is located.
file_namestringObligatorio
The desired filename for the downloaded attachment. This name will be assigned to the `FileDownloadable` object.
message_idstringObligatorio
The unique identifier of the email message that contains the attachment to be downloaded. This ID is typically obtained when listing or retrieving messages.
attachment_idstringObligatorio
The 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get mailbox settingsOUTLOOK_GET_MAILBOX_SETTINGSAcción

Tool 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_idstring
The user's unique identifier or principal name. Use 'me' for the signed-in user.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get mail deltaOUTLOOK_GET_MAIL_DELTAAcción

Tool to retrieve incremental changes (delta) of messages in a mailbox. use when syncing mailbox updates since last checkpoint.

Parámetros de entrada

topinteger
Maximum number of items to return per page.
skipinteger
Number of items to skip for pagination.
countboolean
Include count of total items in the response.
expandstring[]
List of related entities to expand (e.g. ['attachments']).
filterstring
OData filter string to filter messages (e.g. 'isRead eq false').
searchstring
Search 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_idstring
User identifier: 'me' for the signed-in user or the user's email/UPN.
folder_idstring
Mail folder identifier to scope the delta query to that folder (e.g., 'Inbox' or folder ID GUID).
skip_tokenstring
Skip token for paging through large result sets.
delta_tokenstring
Delta token from a previous call to get only changes since that state.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get mail tipsOUTLOOK_GET_MAIL_TIPSAcción

Tool 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_idstring
User principal name (UPN) or 'me' for the signed-in user.
EmailAddressesstring[]Obligatorio
Collection of SMTP addresses of recipients to get MailTips for.
MailTipsOptionsstring[]Obligatorio
List of mail tip types to retrieve for each recipient.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get master categoriesOUTLOOK_GET_MASTER_CATEGORIESAcción

Tool to retrieve the user's master category list. use when you need to get all categories defined for the user.

Parámetros de entrada

topinteger
Maximum number of master categories to return (OData $top).
skipinteger
Number of master categories to skip for pagination (OData $skip).
filterstring
OData $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_idstring
The user's unique identifier or principal name. Use 'me' for the signed-in user.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get supported languagesOUTLOOK_GET_SUPPORTED_LANGUAGESAcción

Tool 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_idstring
The user's unique identifier or principal name. Use 'me' for the signed-in user.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get supported time zonesOUTLOOK_GET_SUPPORTED_TIME_ZONESAcción

Tool 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

timeZoneStandardstringenum
Specifies the time zone format to return. Supported values: 'Windows' or 'Iana'. Default is 'Windows' if not specified.
WindowsIana

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Outlook calendarsOUTLOOK_LIST_CALENDARSAcción

Tool 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

topinteger
Maximum number of calendars to return (OData $top).
skipinteger
Number of calendars to skip (OData $skip).
filterstring
OData filter expression (OData $filter).
selectstring[]
Properties to include (OData $select).
orderbystring[]
Order by expressions (OData $orderby).
user_idstring
User ID or userPrincipalName. Use 'me' for the signed-in user.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List event attachmentsOUTLOOK_LIST_EVENT_ATTACHMENTSAcción

Tool 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

topinteger
Maximum number of attachments to return (OData $top).
skipinteger
Number of attachments to skip (OData $skip).
filterstring
OData 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_idstring
The user's primary SMTP address, UPN, or 'me' for the signed-in user.
event_idstringObligatorio
The unique identifier of the calendar event to retrieve attachments for.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Outlook attachmentsOUTLOOK_LIST_OUTLOOK_ATTACHMENTSAcción

Lists metadata (like name, size, and type, but not `contentbytes`) for all attachments of a specified outlook email message.

Parámetros de entrada

user_idstring
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.
message_idstringObligatorio
The unique identifier of the email message from which to retrieve attachments. This ID is specific to the Outlook message.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List event remindersOUTLOOK_LIST_REMINDERSAcción

Tool 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

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add event attachmentOUTLOOK_OUTLOOK_ADD_EVENT_ATTACHMENTAcción

Adds 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

itemobject
The nested item payload; required when '@odata.type' is itemAttachment.
namestringObligatorio
The display name of the attachment.
user_idstring
The user's email address or 'me' for the authenticated user.
event_idstringObligatorio
The unique identifier of the calendar event to which the attachment will be added.
odata_typestringObligatorioenum
Attachment type: '#microsoft.graph.fileAttachment' requires 'contentBytes'; '#microsoft.graph.itemAttachment' requires 'item'.
#microsoft.graph.fileAttachment#microsoft.graph.itemAttachment
contentBytesstring
Base64-encoded file contents; required when '@odata.type' is fileAttachment.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Calendar EventOUTLOOK_OUTLOOK_CALENDAR_CREATE_EVENTAcción

Creates a new outlook calendar event, ensuring `start datetime` is chronologically before `end datetime`.

Parámetros de entrada

bodystringObligatorio
The body of the event. This can be in plain text or HTML format, as specified by the 'is_html' field.
is_htmlboolean
Specifies whether the 'body' content is HTML. Set to true for HTML content; otherwise, it's treated as plain text.
show_asstring
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'.
subjectstringObligatorio
The subject of the calendar event.
user_idstring
The 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.
locationstring
The physical location of the event.
time_zonestringObligatorio
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.
categoriesstring[]
A list of categories associated with the event. These categories must already exist in the user's mailbox.
end_datetimestringObligatoriodate-time
The 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-time
The start date and time of the event in ISO 8601 format. Time zone is specified in 'time_zone'.
is_online_meetingboolean
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).
online_meeting_providerstring
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create contactOUTLOOK_OUTLOOK_CREATE_CONTACTAcción

Creates a new contact in a microsoft outlook user's contacts folder.

Parámetros de entrada

notesstring
Personal notes about the contact. These notes are stored as 'personalNotes' in the Outlook contact details.
surnamestring
The contact's surname (last name).
user_idstring
Identifier 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').
birthdaystring
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).
jobTitlestring
The contact's job title.
givenNamestring
The contact's given (first) name.
homePhonestring
The 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.
departmentstring
The department the contact belongs to within their company.
companyNamestring
The name of the company the contact is associated with.
displayNamestring
The contact's display name, typically their full name.
mobilePhonestring
The 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.
officeLocationstring
The contact's office location.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create email draftOUTLOOK_OUTLOOK_CREATE_DRAFTAcción

Creates 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

bodystringObligatorio
Content of the email draft; use `is_html` to specify if HTML or plain text.
is_htmlboolean
Specifies if the `body` is HTML. If `False`, `body` is plain text.
subjectstringObligatorio
Subject line for the email draft.
attachmentobject
Optional 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[]Obligatorio
List of primary 'To' recipient email addresses.
bcc_recipientsstring[]
Optional list of BCC (blind carbon copy) recipient email addresses.
conversation_idstring
Optional 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a draft replyOUTLOOK_OUTLOOK_CREATE_DRAFT_REPLYAcción

Creates 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

commentstring
Plain text comment to include in the body of the reply draft.
user_idstring
User'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_idstringObligatorio
Unique ID of the message to reply to, typically obtained from actions like 'List Messages' or 'Get Message'.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete ContactOUTLOOK_OUTLOOK_DELETE_CONTACTAcción

Permanently 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_idstring
The UPN (User Principal Name) or ID of the user; use 'me' for the signed-in user.
contact_idstringObligatorio
Identifier of the contact to be deleted, typically obtained from 'List User Contacts' or 'Get Contact'.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Calendar EventOUTLOOK_OUTLOOK_DELETE_EVENTAcción

Deletes 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_idstring
User's email address or 'me' for the current user.
event_idstringObligatorio
Unique identifier of the calendar event to delete, typically obtained from event listing or retrieval actions.
send_notificationsboolean
If `True`, sends cancellation notifications to event attendees upon deletion.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get contactOUTLOOK_OUTLOOK_GET_CONTACTAcción

Retrieves 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_idstring
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.
contact_idstringObligatorio
Unique identifier for the contact within the specified user's Outlook address book.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get contact foldersOUTLOOK_OUTLOOK_GET_CONTACT_FOLDERSAcción

Tool 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

topinteger
Maximum number of contact folders to return.
skipinteger
Number of contact folders to skip for pagination.
expandstring[]
Related entities to expand inline, e.g., ['contacts'].
filterstring
OData 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_idstring
User principal name or ID. Use 'me' for the authenticated user.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get calendar eventOUTLOOK_OUTLOOK_GET_EVENTAcción

Retrieves 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_idstring
The user's primary SMTP address, user principal name (UPN), or the alias 'me' (for the signed-in user) to identify the calendar owner.
event_idstringObligatorio
The unique identifier of the calendar event to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get email messageOUTLOOK_OUTLOOK_GET_MESSAGEAcción

Retrieves 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

selectstring
Comma-separated list of properties to include. Use 'internetMessageHeaders' to get email headers for filtering automated messages.
user_idstring
User's email address, UPN, or 'me' for the currently authenticated user.
message_idstringObligatorio
Unique ID of the Outlook email message to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Outlook profileOUTLOOK_OUTLOOK_GET_PROFILEAcción

Retrieves the microsoft outlook profile for a specified user.

Parámetros de entrada

user_idstring
The user's unique identifier or principal name. Use 'me' to get the profile of the authenticated user.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get scheduleOUTLOOK_OUTLOOK_GET_SCHEDULEAcción

Retrieves free/busy schedule information for specified email addresses within a defined time window.

Parámetros de entrada

EndTimeobjectObligatorio
The end date, time, and time zone for the period for which to retrieve schedules. The period can be up to 62 days.
Schedulesstring[]Obligatorio
A list of SMTP email addresses for users, distribution lists, or resources whose schedules are to be retrieved. Maximum of 20 addresses.
StartTimeobjectObligatorio
The start date, time, and time zone for the period for which to retrieve schedules.
availabilityViewIntervalstring
The duration of each time slot in the availability view, specified in minutes. Minimum: 5, Maximum: 1440. Default: 30.

Parámetros de salida

dataobject
A 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'.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Outlook contactsOUTLOOK_OUTLOOK_LIST_CONTACTSAcción

Retrieves a user's microsoft outlook contacts, from the default or a specified contact folder.

Parámetros de entrada

topinteger
Maximum number of contacts to retrieve.
filterstring
OData 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_idstring
User Principal Name (UPN) or ID of the user. 'me' refers to the authenticated user.
contact_folder_idstring
ID of a specific contact folder. If omitted, contacts are retrieved from the default contact folder.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List eventsOUTLOOK_OUTLOOK_LIST_EVENTSAcción

Retrieves events from a user's outlook calendar via microsoft graph api, supporting pagination, filtering, property selection, sorting, and timezone specification.

Parámetros de entrada

topinteger
Maximum number of events to retrieve per page for pagination.
skipinteger
Number of initial events to bypass, used for pagination.
filterstring
OData 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_idstring
Email address of the target user (or 'me' for authenticated user), identifying the calendar for event listing.
timezonestring
Preferred IANA or Windows timezone for event start/end times (e.g., 'America/New_York'); defaults to UTC if unspecified/invalid.
expand_recurring_eventsboolean
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.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List mail foldersOUTLOOK_OUTLOOK_LIST_MAIL_FOLDERSAcción

Tool 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_idstring
User's id, userPrincipalName, or 'me' for the signed-in user.
include_hidden_foldersboolean
Include hidden mail folders (isHidden=true) when set to true.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List MessagesOUTLOOK_OUTLOOK_LIST_MESSAGESAcción

Retrieves 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

topinteger
Maximum number of messages to return (1-1000).
skipinteger
Number of messages to skip from the beginning of the result set, for pagination.
folderstring
ID 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_readboolean
Filter 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.
subjectstring
Filter by exact match of the subject line.
user_idstring
Target 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.
importancestring
Filter by importance: 'low', 'normal', or 'high'.
from_addressstring
Filter by the sender's exact email address.
conversationIdstring
Filter messages by conversation ID to retrieve all messages in a specific email thread.
has_attachmentsboolean
Filter by attachment presence: 'true' for messages with attachments, 'false' for those without.
subject_containsstring
Filter messages where the subject contains the specified case-insensitive substring.
subject_endswithstring
Filter messages where the subject ends with the specified case-insensitive string.
sent_date_time_gtstring
Filter messages sent after this ISO 8601 timestamp.
sent_date_time_ltstring
Filter messages sent before this ISO 8601 timestamp.
subject_startswithstring
Filter messages where the subject starts with the specified case-insensitive string.
received_date_time_gestring
Filter messages received on or after this ISO 8601 timestamp.
received_date_time_gtstring
Filter messages received after this ISO 8601 timestamp (e.g., '2023-01-01T00:00:00Z').
received_date_time_lestring
Filter messages received on or before this ISO 8601 timestamp.
received_date_time_ltstring
Filter messages received before this ISO 8601 timestamp.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Move message to folderOUTLOOK_OUTLOOK_MOVE_MESSAGEAcción

Move 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_idstring
User's email address, UPN, or 'me' for the currently authenticated user.
message_idstringObligatorio
Unique ID of the Outlook email message to move.
destination_idstringObligatorio
The destination folder ID, or a well-known folder name (e.g., 'inbox', 'deleteditems', 'drafts', 'sentitems').

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Reply to EmailOUTLOOK_OUTLOOK_REPLY_EMAILAcción

Sends a plain text reply to an outlook email message, identified by `message id`, allowing optional cc and bcc recipients.

Parámetros de entrada

commentstringObligatorio
The plain text body of the reply email.
user_idstring
The 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_idstringObligatorio
The unique ID of the message to reply to. This ID can be obtained from the `OUTLOOK_LIST_MESSAGES` action.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Outlook messagesOUTLOOK_OUTLOOK_SEARCH_MESSAGESAcción

Searches 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

sizeinteger
The maximum number of search results to return in a single response for pagination.
querystringObligatorio
The free-text search string. Can include terms from the message body, attachments, sender, subject, or other properties.
subjectstring
Text to search for within the message subject line.
fromEmailstring
The sender's email address to filter messages; only Microsoft 365/Enterprise domains are supported.
from_indexinteger
The 0-based starting index for the returned search results for pagination.
hasAttachmentsboolean
Filters messages based on the presence of attachments.
enable_top_resultsboolean
If `true`, sorts results by relevance; otherwise, sorts by date in descending order (newest first).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Send emailOUTLOOK_OUTLOOK_SEND_EMAILAcción

Sends 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

bodystringObligatorio
The content of the email body, plain text or HTML based on `is_html`.
is_htmlboolean
Specifies if the email body is HTML; `True` for HTML, `False` for plain text.
subjectstringObligatorio
The subject line of the email.
to_namestring
The display name of the primary recipient.
user_idstring
The user's email address or the alias 'me' to represent the authenticated user.
to_emailstringObligatorio
The primary recipient's email address.
cc_emailsstring[]
List of email addresses for CC recipients.
attachmentobject
Optional 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_itemsboolean
Indicates if the email should be saved in 'Sent Items'.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update calendar eventOUTLOOK_OUTLOOK_UPDATE_CALENDAR_EVENTAcción

Updates specified fields of an existing outlook calendar event.

Parámetros de entrada

bodyobject
The body of the event, specifying content type ('Text' or 'HTML') and the content itself.
show_asstring
The availability status to show for the event. Valid values: 'free', 'tentative', 'busy', 'oof' (out of office).
subjectstring
The new subject for the event. If explicitly set to an empty string, the event's subject will be cleared.
user_idstring
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.
event_idstringObligatorio
The unique identifier of the calendar event to be updated. This ID can be obtained from the OUTLOOK_LIST_EVENTS action.
locationobject
The 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_zonestring
The 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-time
The 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-time
The 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ContactOUTLOOK_OUTLOOK_UPDATE_CONTACTAcción

Updates 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

notesstring
Personal notes about the contact (maps to 'personalNotes' in Microsoft Graph API).
surnamestring
Contact's surname (last name).
user_idstring
User's identifier; 'me' for the signed-in user, or user's principal name/ID.
birthdaystring
Contact's birthday (YYYY-MM-DD format).
jobTitlestring
Contact's job title.
givenNamestring
Contact's given (first) name.
categoriesstring[]
Categories for organizing the contact.
contact_idstringObligatorio
Unique identifier of the contact to update.
departmentstring
Contact's department.
homePhonesstring[]
Contact's home phone numbers.
companyNamestring
Contact's company name.
displayNamestring
Contact's full display name.
mobilePhonestring
Contact's mobile phone number.
businessPhonesstring[]
Contact's business phone numbers.
emailAddressesobject[]
Contact's email addresses.
officeLocationstring
Contact's office location.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update email messageOUTLOOK_OUTLOOK_UPDATE_EMAILAcción

Updates 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

bodyobject
New body content (Text or HTML). If omitted, the existing message body remains unchanged.
subjectstring
New subject. Omitting or providing an empty string clears the subject. To preserve the current subject, provide its existing value.
user_idstring
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.
importancestring
New importance level ('low', 'normal', 'high'). If omitted, importance is set to 'normal'.
message_idstringObligatorio
The 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

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update mailbox settingsOUTLOOK_UPDATE_MAILBOX_SETTINGSAcción

Tool 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

languageobject
Locale preferences for date/time formatting.
timeZonestring
Default mailbox time zone (e.g., 'Pacific Standard Time').
workingHoursobject
Working hours configuration for the user.
automaticRepliesSettingobject
Configuration for automatic replies.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether 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_TRIGGERTrigger

Triggered when a new contact is added in the Outlook contacts.

Configuración

Sin parámetros.

Payload del evento

event_typestringObligatorio
Type of event
idstringObligatorio
The unique identifier for the message

Calendar Event ChangesOUTLOOK_EVENT_CHANGE_TRIGGERTrigger

Triggered when a new calendar event occurs (created, updated, or deleted) in the Outlook calendar.

Configuración

Sin parámetros.

Payload del evento

event_typestringObligatorio
Type of event
idstringObligatorio
The unique identifier for the message

New Calendar EventOUTLOOK_EVENT_TRIGGERTrigger

Triggered when a new calendar event is created in the Outlook calendar.

Configuración

Sin parámetros.

Payload del evento

event_typestringObligatorio
Type of event
idstringObligatorio
The unique identifier for the message

New Outlook MessageOUTLOOK_MESSAGE_TRIGGERTrigger

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

Configuración

folder_idstring
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.
from_emailstring
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.
has_attachmentsboolean
Only fire for messages that do (`true`) or do not (`false`) have attachments. Note that Outlook counts an inline image as an attachment.
importancestringenum
Only fire for messages with this importance level.
lownormalhigh
subject_containsstring
Only fire when the message subject contains this text. Case-insensitive. Matched as given, so leading and trailing whitespace is significant.
to_emailstring
Only fire for messages addressed to this address on the To line. Case-insensitive. Cc and Bcc recipients are not matched.

Payload del evento

event_typestringObligatorio
Type of event
idstringObligatorio
The unique identifier for the message
messageobject
Deprecated Outlook message field. Use `outlook_message` instead.
outlook_messageobject
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`.

New Sent MessageOUTLOOK_SENT_MESSAGE_TRIGGERTrigger

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

Configuración

folder_idstring
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.
from_emailstring
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.
has_attachmentsboolean
Only fire for messages that do (`true`) or do not (`false`) have attachments. Note that Outlook counts an inline image as an attachment.
importancestringenum
Only fire for messages with this importance level.
lownormalhigh
subject_containsstring
Only fire when the message subject contains this text. Case-insensitive. Matched as given, so leading and trailing whitespace is significant.
to_emailstring
Only fire for messages addressed to this address on the To line. Case-insensitive. Cc and Bcc recipients are not matched.

Payload del evento

event_typestringObligatorio
Type of event
idstringObligatorio
The unique identifier for the message
messageobject
Deprecated Outlook message field. Use `outlook_message` instead.
outlook_messageobject
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`.