Outlook.com

Outlook.com

Outlook.com connector allows you to manage your mail, calendars, and contacts. You can perform various actions such as send mail, schedule meetings, add contacts, etc.

Note:

  • This is a Standard connector.

To use this integration, you will need access to an Outlook mailbox that has the REST API enabled. To make a connection, select Sign In. You will be prompted to provide your Outlook account, follow the remainder of the screens to create a connection.

If you see an error using the connector, please check that the REST API is enabled. Accounts on a dedicated (on-premise) mail server or accounts that are sandbox (test) accounts may also see an error.

Support for certain attachment types (EML, MSG, ICS) is currently limited. These attachments will be skipped when processing emails.

You're now ready to start using this integration.

Throttling Limits

Name Calls Renewal Period
API calls per connection 600 60 seconds

Actions

Create contact

This operation creates a new contact in a contacts folder.

Required Parameters

Folder id
string
Select a contacts folder
Given name
string
The contact's given name

Optional Parameters

Id
string
The contact's unique identifier.
Parent folder id
string
The ID of the contact's parent folder
Birthday
date-time
The contact's birthday
File as
string
The name the contact is filed under
Display Name
string
The contact's display name
Initials
string
The contact's initials
Middle name
string
The contact's middle name
Nickname
string
The contact's nickname
Surname
string
The contact's surname
Title
string
The contact's title
Generation
string
The contact's generation
Name
string
Address
email
IM addresses
string
JobTitle
string
The contact's job title
Company name
string
The name of the contact's company
Department
string
The contact's department
Office location
string
The location of the contact's office
Profession
string
The contact's profession
Business home page
string
The business home page of the contact
Assistant name
string
The name of the contact's assistant
Manager
string
The name of the contact's manager
Home phones
string
Business phones
string
Mobile phone
string
The contact's mobile phone number
Street
string
City
string
State
string
CountryOrRegion
string
PostalCode
string
Street
string
City
string
State
string
CountryOrRegion
string
PostalCode
string
Street
string
City
string
State
string
CountryOrRegion
string
PostalCode
string
Yomi company name
string
The phonetic Japanese company name of the contact
Yomi given name
string
The phonetic Japanese given name (first name) of the contact
Yomi surname
string
The phonetic Japanese surname (last name) of the contact
Categories
string
Change key
string
Identifies the version of the event object
Created time
date-time
The time the contact was created
Last modified time
date-time
The time the contact was modified

Returns

Body
Contact

Contact

Create event (V1) [DEPRECATED]

This operation creates a new event in a calendar. (V1)

Required Parameters

Calendar id
string
Select a calendar
End time
date-time
The end time of the event
Start time
date-time
The start time of the event
Subject
string
Event subject

Optional Parameters

Id
string
The Event's unique identifier
Response
string
Time
date-time
Type
string
Name
string
Address
email
ContentType
string
Content
string
Body preview
string
The preview of the message associated with the event
Categories
string
Change key
string
This property identifies the version of the event object. Every time the event is changed, ChangeKey changes as well.
Created time
date-time
The date and time that the event was created
Last modified time
date-time
The date and time that the event was last modified
End time zone
string
This property specifies the time zone of the meeting end time. The value must be as defined in Windows (example: 'Pacific Standard Time').
Has attachments?
boolean
Set to true if the event has attachments
Importance
string
The importance of the event: Low, Normal, or High
Is all day event?
boolean
Set to true if the event lasts all day
Is cancelled?
boolean
Set to true if the event has been canceled
Is Organizer
boolean
Set to true if the message sender is also the organizer
DisplayName
string
Street
string
City
string
State
string
CountryOrRegion
string
PostalCode
string
Altitude
double
Latitude
double
Longitude
double
Accuracy
double
AltitudeAccuracy
double
Name
string
Address
email
Type
string
Interval
integer
Month
integer
DayOfMonth
integer
DaysOfWeek
string
FirstDayOfWeek
string
Index
string
Type
string
StartDate
date-time
EndDate
date-time
NumberOfOccurrences
integer
Reminder
integer
Time in minutes before event start to remind
Response requested
boolean
Set to true if the sender would like a response when the event is accepted or declined
Response
string
Time
date-time
Series master id
string
Unique identifier for Series Master event type
Show as
string
Shows as free or busy
Start time zone
string
This property specifies the time zone of the meeting start time. The value must be as defined in Windows (example: 'Pacific Standard Time').
Type
string
The event type: Single Instance, Occurrence, Exception, or Series Master
Web link
uri
The preview of the message associated with the event
Reason
string
The reason property used by O365 sync events protocol, will be 'deleted' if its a deleted event.

Returns

Body
CalendarEventBackend

Connector specific calendar event model class for the backend

Create event (V2)

This operation creates a new event in a calendar. (V2)

Required Parameters

Calendar id
string
Select a calendar
Subject
string
Event subject
Start time
date-time
Start time of the event (example: '2016-11-01T14:30:00')
End time
date-time
End time of the event (example: '2016-11-01T15:30:00')

Optional Parameters

Time zone
string
Time zone of the event
Required attendees
email
Required attendees for the event separated by semicolons
Optional attendees
email
Optional attendees for the event separated by semicolons
Body
string
Body of the message associated with the event
Is HTML
boolean
Set to true if the body is Html
Location
string
Location of the event
Importance
string
The importance of the event: Low, Normal, or High
Is all day event?
boolean
Set to true if the event lasts all day
Recurrence
string
The recurrence pattern for the event
Recurrence end time
date-time
End time of the recurrence
Number of occurrences
integer
How many times to repeat the event
Reminder
integer
Time in minutes before event start to remind
Show as
string
Status to show during the event
Response requested
boolean
Set to true if the sender would like a response when the event is accepted or declined

Returns

Body
CalendarEventClientReceive

Connector specific calendar event model class for the client

Delete contact

This operation deletes a contact from a contacts folder.

Required Parameters

Folder id
string
Select a contacts folder
Id
string
Unique identifier of contact to delete

Returns

Body
Contact

Contact

Delete email

This operation deletes an email by id.

Required Parameters

Message Id
string
Id of the email to delete.

Returns

Body
Contact

Contact

Delete event

This operation deletes an event in a calendar.

Required Parameters

Calendar id
string
Select a calendar
Id
string
Select an event

Returns

Body
Contact

Contact

Flag email

This operation flags an email.

Required Parameters

Message Id
string
Id of the email to be flagged.

Returns

Body
Contact

Contact

Forward an email

Forward an email.

Required Parameters

Message Id
string
Id of the message to forward.
To
string
Semicolon separated list of recipients to forward the message to

Optional Parameters

Comment
string
Comment

Returns

Body
Contact

Contact

Get attachment

This operation gets an email attachment by id.

Required Parameters

Message Id
string
Id of the email.
Attachment Id
string
Id of the attachment to download.

Returns

Body
Contact

Contact

Get calendar view of events (V2)

This operation gets all events (including instances of recurrences) in a calendar. (V2)

Required Parameters

Calendar Id
string
Select a calendar
Start Time
string
Start time (example: '2017-01-01T08:00:00-07:00')
End Time
string
End time (example: '2017-02-01T08:00:00-07:00')

Optional Parameters

Filter Query
string
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).
Order By
string
An ODATA orderBy query for specifying the order of entries.
Top Count
integer
Total number of entries to retrieve (default = all).
Skip Count
integer
The number of entries to skip (default = 0).
Search
string
Search text for matching event body and subject

Returns

Get calendar view of events [DEPRECATED]

Get calendar view of events.

Required Parameters

Calendar Id
string
Select a calendar.
Start Time
string
Start time (example: '2017-01-01T08:00:00-07:00').
End Time
string
End time (example: '2017-02-01T08:00:00-07:00').

Returns

Body
PaginatedListResponse[CalendarEventClientReceive]

Response containing a list and next link

Get calendars

This operation lists available calendars.

Required Parameters

Folder id
string
Select a contacts folder
Given name
string
The contact's given name

Optional Parameters

Id
string
The contact's unique identifier.
Parent folder id
string
The ID of the contact's parent folder
Birthday
date-time
The contact's birthday
File as
string
The name the contact is filed under
Display Name
string
The contact's display name
Initials
string
The contact's initials
Middle name
string
The contact's middle name
Nickname
string
The contact's nickname
Surname
string
The contact's surname
Title
string
The contact's title
Generation
string
The contact's generation
Name
string
Address
email
IM addresses
string
JobTitle
string
The contact's job title
Company name
string
The name of the contact's company
Department
string
The contact's department
Office location
string
The location of the contact's office
Profession
string
The contact's profession
Business home page
string
The business home page of the contact
Assistant name
string
The name of the contact's assistant
Manager
string
The name of the contact's manager
Home phones
string
Business phones
string
Mobile phone
string
The contact's mobile phone number
Street
string
City
string
State
string
CountryOrRegion
string
PostalCode
string
Street
string
City
string
State
string
CountryOrRegion
string
PostalCode
string
Street
string
City
string
State
string
CountryOrRegion
string
PostalCode
string
Yomi company name
string
The phonetic Japanese company name of the contact
Yomi given name
string
The phonetic Japanese given name (first name) of the contact
Yomi surname
string
The phonetic Japanese surname (last name) of the contact
Categories
string
Change key
string
Identifies the version of the event object
Created time
date-time
The time the contact was created
Last modified time
date-time
The time the contact was modified

Returns

Body
EntityListResponse[Table]

Entity list response

Get contact

This operation gets a specific contact from a contacts folder.

Required Parameters

Folder id
string
Select a contacts folder
Item id
string
Unique identifier of a contact to retrieve

Returns

Body
Contact

Contact

Get contact folders

This operation lists available contacts folders.

Required Parameters

Folder id
string
Select a contacts folder
Given name
string
The contact's given name

Optional Parameters

Id
string
The contact's unique identifier.
Parent folder id
string
The ID of the contact's parent folder
Birthday
date-time
The contact's birthday
File as
string
The name the contact is filed under
Display Name
string
The contact's display name
Initials
string
The contact's initials
Middle name
string
The contact's middle name
Nickname
string
The contact's nickname
Surname
string
The contact's surname
Title
string
The contact's title
Generation
string
The contact's generation
Name
string
Address
email
IM addresses
string
JobTitle
string
The contact's job title
Company name
string
The name of the contact's company
Department
string
The contact's department
Office location
string
The location of the contact's office
Profession
string
The contact's profession
Business home page
string
The business home page of the contact
Assistant name
string
The name of the contact's assistant
Manager
string
The name of the contact's manager
Home phones
string
Business phones
string
Mobile phone
string
The contact's mobile phone number
Street
string
City
string
State
string
CountryOrRegion
string
PostalCode
string
Street
string
City
string
State
string
CountryOrRegion
string
PostalCode
string
Street
string
City
string
State
string
CountryOrRegion
string
PostalCode
string
Yomi company name
string
The phonetic Japanese company name of the contact
Yomi given name
string
The phonetic Japanese given name (first name) of the contact
Yomi surname
string
The phonetic Japanese surname (last name) of the contact
Categories
string
Change key
string
Identifies the version of the event object
Created time
date-time
The time the contact was created
Last modified time
date-time
The time the contact was modified

Returns

Body
EntityListResponse[Table]

Entity list response

Get contacts

This operation gets contacts from a contacts folder.

Required Parameters

Folder id
string
Unique identifier of the contacts folder to retrieve

Optional Parameters

Filter Query
string
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).
Order By
string
An ODATA orderBy query for specifying the order of entries.
Top Count
integer
Total number of entries to retrieve (default = all).
Skip Count
integer
The number of entries to skip (default = 0).

Returns

Body
EntityListResponse[Contact]

Entity list response

Get email

This operation gets an email by id.

Required Parameters

Message Id
string
Id of the email.

Optional Parameters

Include Attachments
boolean
If set to true, attachments will also be retrieved along with the email.

Returns

Body
ClientReceiveMessage

Receive Email Message

Get emails

This operation gets emails from a folder.

Optional Parameters

Folder
string
Mail folder to retrieve emails from (default: 'Inbox').
Fetch Only Unread Messages
boolean
Retrieve only unread emails?.
Include Attachments
boolean
If set to true, attachments will also be retrieved along with the email.
Search Query
string
Search query (like in the Outlook client) to filter emails.
Top
integer
Number of emails to retrieve (default: 10).

Returns

Get emails (V2)

This operation gets emails from a folder.

Optional Parameters

Folder
string
Mail folder to retrieve emails from (default: 'Inbox').
To
email
Recipient email addresses separated by semicolons (If any match, the trigger will run).
CC
email
CC recipient email addresses separated by semicolons (If any match, the trigger will run).
To or CC
email
To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).
From
email
Sender email addresses separated by semicolons (If any match, the trigger will run).
Importance
string
Importance of the email (Any, High, Normal, Low).
Has Attachment
boolean
Should the email contain attachments.
Subject Filter
string
String to look for in the subject line.
Fetch Only Unread Messages
boolean
Retrieve only unread emails?.
Include Attachments
boolean
If set to true, attachments will also be retrieved along with the email.
Search Query
string
Search query (like in the Outlook client) to filter emails.
Top
integer
Number of emails to retrieve (default: 10).

Returns

Body
BatchResponse[ClientReceiveMessage]

Represents a wrapper object for batch response

Get event (V1) [DEPRECATED]

This operation gets a specific event from a calendar. (V1)

Required Parameters

Calendar id
string
Select a calendar
Item id
string
Select an event

Returns

Body
CalendarEventBackend

Connector specific calendar event model class for the backend

Get event (V2)

This operation gets a specific event from a calendar. (V2)

Required Parameters

Calendar id
string
Select a calendar
Item id
string
Select an event

Returns

Body
CalendarEventClientReceive

Connector specific calendar event model class for the client

Get events (V1) [DEPRECATED]

This operation gets events from a calendar. (V1)

Required Parameters

Calendar id
string
Select a calendar

Optional Parameters

Order By
string
An ODATA orderBy query for specifying the order of entries.
Top Count
integer
Total number of entries to retrieve (default = all).
Skip Count
integer
The number of entries to skip (default = 0).

Returns

Body
EntityListResponse[CalendarEventBackend]

Entity list response

Get events (V2)

This operation gets events from a calendar. (V2)

Required Parameters

Calendar id
string
Select a calendar

Optional Parameters

Filter Query
string
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).
Order By
string
An ODATA orderBy query for specifying the order of entries.
Top Count
integer
Total number of entries to retrieve (default = all).
Skip Count
integer
The number of entries to skip (default = 0).

Returns

Mark as read

This operation marks an email as having been read.

Required Parameters

Message Id
string
Id of the email to be marked as read.

Returns

Body
Contact

Contact

Move email

This operation moves an email to the specified folder.

Required Parameters

Message Id
string
Id of the email to be moved.
Folder
string
Mail folder to move the email to.

Returns

Body
Contact

Contact

Reply to email

This operation replies to an email.

Required Parameters

Message Id
string
Id of the email to reply to.
Comment
string
Reply comment.

Optional Parameters

Reply All
boolean
Reply to all recipients.

Returns

Body
Contact

Contact

Reply to email (V2)

This operation replies to an email.

Required Parameters

Message Id
string
Id of the email to reply to.
Name
string
Attachment name
Content
byte
Attachment content

Optional Parameters

To
email
Example: recipient1@domain.com; recipient2@domain.com
CC
email
Example: recipient1@domain.com; recipient2@domain.com
BCC
email
Example: recipient1@domain.com; recipient2@domain.com
Subject
string
Email subject (if empty, the original subject used).
Body
string
Content of the email.
Reply All
boolean
True to reply to all recipients. (default: False)
Is HTML
boolean
True to send the reply as HTML. (default: True)
Importance
string
Pick an importance. (default: Normal)

Returns

Body
Contact

Contact

Respond to an event invite

Respond to an event invite.

Required Parameters

Event Id
string
Id of the event to respond to.
Response
string
Response for the event invite

Optional Parameters

Comment
string
Comment
Send response?
boolean
Send response to organizer?

Returns

Body
Contact

Contact

Send an email

This operation sends an email message.

Required Parameters

To
email
Specify email addresses separated by semicolons like someone@contoso.com
Subject
string
Specify the subject of the mail
Body
string
Specify the body of the mail
Name
string
Attachment name
Content
byte
Attachment content

Optional Parameters

CC
email
Specify email addresses separated by semicolons like someone@contoso.com
BCC
email
Specify email addresses separated by semicolons like someone@contoso.com
Importance
string
Importance
Is HTML
boolean
Is Html?

Returns

Body
Contact

Contact

Send an email (V2)

This operation sends an email message.

Required Parameters

To
email
Specify email addresses separated by semicolons like someone@contoso.com
Subject
string
Specify the subject of the mail
Body
html
Specify the body of the mail
Name
string
Attachment name
Content
byte
Attachment content

Optional Parameters

CC
email
Specify email addresses separated by semicolons like someone@contoso.com
BCC
email
Specify email addresses separated by semicolons like someone@contoso.com
Importance
string
Importance

Returns

Body
Contact

Contact

Send approval email

This operation sends an approval email and waits for a response from the recipient. Please refer to the following link regarding the support of actionable messages in different mail clients: https://docs.microsoft.com/en-us/outlook/actionable-messages/#outlook-version-requirements-for-actionable-messages.

Required Parameters

To
email
Specify email addresses separated by semicolons like someone@contoso.com
Name
string
Attachment name
Content
byte
Attachment content

Optional Parameters

Subject
string
Subject
User Options
string
User Options
Header Text
string
Header text for email body
Selection Text
string
Header text for users options selection
Body
string
Body
Importance
string
Importance
Use only HTML message
boolean
Use only HTML message

Returns

Body
ApprovalEmailResponse

Approval Email Response

Send email with options

This operation sends an email with multiple options and waits for the recipient to respond back with one of the options. Please refer to the following link regarding the support of actionable messages in different mail clients: https://docs.microsoft.com/en-us/outlook/actionable-messages/#outlook-version-requirements-for-actionable-messages.

Required Parameters

To
email
Specify email addresses separated by semicolons like someone@contoso.com
Name
string
Attachment name
Content
byte
Attachment content

Optional Parameters

Subject
string
Subject of the email
User Options
string
List of comma separated options for the email response
Header Text
string
Header text for email body
Selection Text
string
Header text for users options selection
Body
string
Body of the email
Importance
string
Importance
Use only HTML message
boolean
Use only HTML message

Returns

Body
ApprovalEmailResponse

Approval Email Response

Update contact

This operation updates a contact in a contacts folder.

Required Parameters

Folder id
string
Select a contacts folder
Id
string
Unique identifier of contact to update
Given name
string
The contact's given name

Optional Parameters

Id
string
The contact's unique identifier.
Parent folder id
string
The ID of the contact's parent folder
Birthday
date-time
The contact's birthday
File as
string
The name the contact is filed under
Display Name
string
The contact's display name
Initials
string
The contact's initials
Middle name
string
The contact's middle name
Nickname
string
The contact's nickname
Surname
string
The contact's surname
Title
string
The contact's title
Generation
string
The contact's generation
Name
string
Address
email
IM addresses
string
JobTitle
string
The contact's job title
Company name
string
The name of the contact's company
Department
string
The contact's department
Office location
string
The location of the contact's office
Profession
string
The contact's profession
Business home page
string
The business home page of the contact
Assistant name
string
The name of the contact's assistant
Manager
string
The name of the contact's manager
Home phones
string
Business phones
string
Mobile phone
string
The contact's mobile phone number
Street
string
City
string
State
string
CountryOrRegion
string
PostalCode
string
Street
string
City
string
State
string
CountryOrRegion
string
PostalCode
string
Street
string
City
string
State
string
CountryOrRegion
string
PostalCode
string
Yomi company name
string
The phonetic Japanese company name of the contact
Yomi given name
string
The phonetic Japanese given name (first name) of the contact
Yomi surname
string
The phonetic Japanese surname (last name) of the contact
Categories
string
Change key
string
Identifies the version of the event object
Created time
date-time
The time the contact was created
Last modified time
date-time
The time the contact was modified

Returns

Body
Contact

Contact

Update event (V1) [DEPRECATED]

This operation updates an event in a calendar. (V1)

Required Parameters

Calendar id
string
Select a calendar
Id
string
Select an event
End time
date-time
The end time of the event
Start time
date-time
The start time of the event
Subject
string
Event subject

Optional Parameters

Id
string
The Event's unique identifier
Response
string
Time
date-time
Type
string
Name
string
Address
email
ContentType
string
Content
string
Body preview
string
The preview of the message associated with the event
Categories
string
Change key
string
This property identifies the version of the event object. Every time the event is changed, ChangeKey changes as well.
Created time
date-time
The date and time that the event was created
Last modified time
date-time
The date and time that the event was last modified
End time zone
string
This property specifies the time zone of the meeting end time. The value must be as defined in Windows (example: 'Pacific Standard Time').
Has attachments?
boolean
Set to true if the event has attachments
Importance
string
The importance of the event: Low, Normal, or High
Is all day event?
boolean
Set to true if the event lasts all day
Is cancelled?
boolean
Set to true if the event has been canceled
Is Organizer
boolean
Set to true if the message sender is also the organizer
DisplayName
string
Street
string
City
string
State
string
CountryOrRegion
string
PostalCode
string
Altitude
double
Latitude
double
Longitude
double
Accuracy
double
AltitudeAccuracy
double
Name
string
Address
email
Type
string
Interval
integer
Month
integer
DayOfMonth
integer
DaysOfWeek
string
FirstDayOfWeek
string
Index
string
Type
string
StartDate
date-time
EndDate
date-time
NumberOfOccurrences
integer
Reminder
integer
Time in minutes before event start to remind
Response requested
boolean
Set to true if the sender would like a response when the event is accepted or declined
Response
string
Time
date-time
Series master id
string
Unique identifier for Series Master event type
Show as
string
Shows as free or busy
Start time zone
string
This property specifies the time zone of the meeting start time. The value must be as defined in Windows (example: 'Pacific Standard Time').
Type
string
The event type: Single Instance, Occurrence, Exception, or Series Master
Web link
uri
The preview of the message associated with the event
Reason
string
The reason property used by O365 sync events protocol, will be 'deleted' if its a deleted event.

Returns

Body
CalendarEventBackend

Connector specific calendar event model class for the backend

Update event (V2)

This operation updates an event in a calendar. (V2)

Required Parameters

Calendar id
string
Select a calendar
Id
string
Select an event
Subject
string
Event subject
Start time
date-time
Start time of the event (example: '2016-11-01T14:30:00')
End time
date-time
End time of the event (example: '2016-11-01T15:30:00')

Optional Parameters

Time zone
string
Time zone of the event
Required attendees
email
Required attendees for the event separated by semicolons
Optional attendees
email
Optional attendees for the event separated by semicolons
Body
string
Body of the message associated with the event
Is HTML
boolean
Set to true if the body is Html
Location
string
Location of the event
Importance
string
The importance of the event: Low, Normal, or High
Is all day event?
boolean
Set to true if the event lasts all day
Recurrence
string
The recurrence pattern for the event
Recurrence end time
date-time
End time of the recurrence
Number of occurrences
integer
How many times to repeat the event
Reminder
integer
Time in minutes before event start to remind
Show as
string
Status to show during the event
Response requested
boolean
Set to true if the sender would like a response when the event is accepted or declined

Returns

Body
CalendarEventClientReceive

Connector specific calendar event model class for the client

Triggers

When a new email arrives

This operation triggers a flow when a new email arrives. It will skip any email that has a total message size greater than the limit put by your Exchange Admin or 50 MB, whichever is less. It may also skip protected emails and emails with invalid body or attachments.

Optional Parameters

Folder
string
Mail folder to check for new emails.
To
email
Recipient email addresses separated by semicolons (If any match, the trigger will run).
CC
email
CC recipient email addresses separated by semicolons (If any match, the trigger will run).
To or CC
email
To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).
From
email
Sender email addresses separated by semicolons (If any match, the trigger will run).
Importance
string
Importance of the email (Any, High, Normal, Low).
Has Attachment
boolean
Should the email contain attachments.
Include Attachments
boolean
Should the response of the trigger include the attachments.
Subject Filter
string
String to look for in the subject line.

Returns

Body
TriggerBatchResponse[ClientReceiveMessage]

Represents a wrapper object for batch trigger response

When a new email mentioning me arrives

This operation triggers a flow when a new email mentioning me arrives. It will skip any email that has a total message size greater than the limit put by your Exchange Admin or 50 MB, whichever is less. It may also skip protected emails and emails with invalid body or attachments.

Optional Parameters

Folder
string
Mail folder to check for new emails.
To
email
Recipient email addresses separated by semicolons (If any match, the trigger will run).
CC
email
CC recipient email addresses separated by semicolons (If any match, the trigger will run).
To or CC
email
To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).
From
email
Sender email addresses separated by semicolons (If any match, the trigger will run).
Importance
string
Importance of the email (Any, High, Normal, Low).
Has Attachment
boolean
Should the email contain attachments.
Include Attachments
boolean
Should the response of the trigger include the attachments.
Subject Filter
string
String to look for in the subject line.

Returns

Body
TriggerBatchResponse[ClientReceiveMessage]

Represents a wrapper object for batch trigger response

When a new event is created (V1) [DEPRECATED]

This operation triggers a flow when a new event is created in a calendar. (V1)

Required Parameters

Calendar id
string
Select a calendar

Optional Parameters

Order By
string
An ODATA orderBy query for specifying the order of entries.
Top Count
integer
Total number of entries to retrieve (default = all).
Skip Count
integer
The number of entries to skip (default = 0).

Returns

Body
CalendarEventList

The list of calendar items

When a new event is created (V2)

This operation triggers a flow when a new event is created in a calendar. (V2)

Required Parameters

Calendar id
string
Select a calendar

Optional Parameters

Order By
string
An ODATA orderBy query for specifying the order of entries.
Top Count
integer
Total number of entries to retrieve (default = all).
Skip Count
integer
The number of entries to skip (default = 0).

Returns

Body
CalendarEventListClientReceive

The list of calendar items

When an email is flagged

This operation triggers a flow when an email is flagged.

Optional Parameters

Folder
string
Mail folder to check for new emails.
To
email
Recipient email addresses separated by semicolons (If any match, the trigger will run).
CC
email
CC recipient email addresses separated by semicolons (If any match, the trigger will run).
To or CC
email
To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).
From
email
Sender email addresses separated by semicolons (If any match, the trigger will run).
Importance
string
Importance of the email (Any, High, Normal, Low).
Has Attachment
boolean
Should the email contain attachments.
Include Attachments
boolean
Should the response of the trigger include the attachments.
Subject Filter
string
String to look for in the subject line.

Returns

Body
TriggerBatchResponse[ClientReceiveMessage]

Represents a wrapper object for batch trigger response

When an event is added, updated or deleted

This operation triggers a flow when an event is added, updated or deleted in a calendar.

Required Parameters

Calendar id
string
Select a calendar

Optional Parameters

Incoming Days Tracked
integer
Number of incoming days in calendar to be tracked
Past Days Tracked
integer
Number of past days in calendar to be tracked

Returns

Body
CalendarEventListWithActionType

The list of calendar items with action type

When an event is modified (V1) [DEPRECATED]

This operation triggers a flow when an event is modified in a calendar. (V1)

Required Parameters

Calendar id
string
Select a calendar

Optional Parameters

Order By
string
An ODATA orderBy query for specifying the order of entries.
Top Count
integer
Total number of entries to retrieve (default = all).
Skip Count
integer
The number of entries to skip (default = 0).

Returns

Body
CalendarEventList

The list of calendar items

When an event is modified (V2)

This operation triggers a flow when an event is modified in a calendar. (V2)

Required Parameters

Calendar id
string
Select a calendar

Optional Parameters

Order By
string
An ODATA orderBy query for specifying the order of entries.
Top Count
integer
Total number of entries to retrieve (default = all).
Skip Count
integer
The number of entries to skip (default = 0).

Returns

Body
CalendarEventListClientReceive

The list of calendar items

When an upcoming event is starting soon

This operation triggers a flow when an upcoming calendar event is starting.

Required Parameters

Calendar Id
string
Unique identifier of the calendar.

Optional Parameters

Look-Ahead Time
integer
Time (in minutes) to look ahead for upcoming events.

Returns

Body
CalendarEventList

The list of calendar items

When an upcoming event is starting soon (V2)

This operation triggers a flow when an upcoming calendar event is starting.

Required Parameters

Calendar Id
string
Unique identifier of the calendar.

Optional Parameters

Look-Ahead Time
integer
Time (in minutes) to look ahead for upcoming events.

Returns

Body
CalendarEventListClientReceive

The list of calendar items

Definitions

CalendarEventList

The list of calendar items

value
array of CalendarEventBackend
List of calendar items

CalendarEventBackend

Connector specific calendar event model class for the backend

Attendees
array of Attendee
List of attendees for the event
Body
ItemBody
Connector specific calendar event model class for the backend
Body preview
string
The preview of the message associated with the event
Categories
array of string
The categories associated with the event
Change key
string
This property identifies the version of the event object. Every time the event is changed, ChangeKey changes as well.
Created time
date-time
The date and time that the event was created
End time
date-time
The end time of the event
End time zone
string
This property specifies the time zone of the meeting end time. The value must be as defined in Windows (example: 'Pacific Standard Time').
Has attachments?
boolean
Set to true if the event has attachments
Id
string
The Event's unique identifier
Importance
string
The importance of the event: Low, Normal, or High
Is Organizer
boolean
Set to true if the message sender is also the organizer
Is all day event?
boolean
Set to true if the event lasts all day
Is cancelled?
boolean
Set to true if the event has been canceled
Last modified time
date-time
The date and time that the event was last modified
Location
Location
Connector specific calendar event model class for the backend
Organizer
Recipient
Connector specific calendar event model class for the backend
Reason
string
The reason property used by O365 sync events protocol, will be 'deleted' if its a deleted event.
Recurrence
PatternedRecurrence
Connector specific calendar event model class for the backend
Reminder
integer
Time in minutes before event start to remind
Response requested
boolean
Set to true if the sender would like a response when the event is accepted or declined
ResponseStatus
ResponseStatus
Connector specific calendar event model class for the backend
Series master id
string
Unique identifier for Series Master event type
Show as
string
Shows as free or busy
Start time
date-time
The start time of the event
Start time zone
string
This property specifies the time zone of the meeting start time. The value must be as defined in Windows (example: 'Pacific Standard Time').
Subject
string
Event subject
Type
string
The event type: Single Instance, Occurrence, Exception, or Series Master
Web link
uri
The preview of the message associated with the event

Attendee

EmailAddress
EmailAddress
Status
ResponseStatus
Type
string

ItemBody

Content
string
ContentType
string

Location

Address
PhysicalAddress
Coordinates
GeoCoordinates
DisplayName
string

Recipient

EmailAddress
EmailAddress

PatternedRecurrence

Pattern
RecurrencePattern
Range
RecurrenceRange

ResponseStatus

Response
string
Time
date-time

EmailAddress

Address
email
Name
string

PhysicalAddress

City
string
CountryOrRegion
string
PostalCode
string
State
string
Street
string

GeoCoordinates

Accuracy
double
Altitude
double
AltitudeAccuracy
double
Latitude
double
Longitude
double

RecurrencePattern

DayOfMonth
integer
DaysOfWeek
array of string
FirstDayOfWeek
string
Index
string
Interval
integer
Month
integer
Type
string

RecurrenceRange

EndDate
date-time
NumberOfOccurrences
integer
StartDate
date-time
Type
string

CalendarEventListClientReceive

The list of calendar items

value
array of CalendarEventClientReceive
List of calendar items

CalendarEventClientReceive

Connector specific calendar event model class for the client

Body
string
Body of the message associated with the event
Categories
array of string
The categories associated with the event
Created time
date-time
The date and time that the event was created
End time
date-time
End time of the event (example: '2016-11-01T15:30:00')
Id
string
The event's unique identifier
Importance
string
The importance of the event: Low, Normal, or High
Is HTML
boolean
Set to true if the body is Html
Is all day event?
boolean
Set to true if the event lasts all day
Last modified time
date-time
The date and time that the event was last modified
Location
string
Location of the event
Number of occurrences
integer
How many times to repeat the event
Optional attendees
email
Optional attendees for the event separated by semicolons
Organizer
email
The organizer of the event
Recurrence
string
The recurrence pattern for the event
Recurrence end time
date-time
End time of the recurrence
Reminder
integer
Time in minutes before event start to remind
Required attendees
email
Required attendees for the event separated by semicolons
Response requested
boolean
Set to true if the sender would like a response when the event is accepted or declined
Series master id
string
Unique identifier for Series Master event type
Show as
string
Status to show during the event
Start time
date-time
Start time of the event (example: '2016-11-01T14:30:00')
Subject
string
Event subject
Time zone
string
Time zone of the event

PaginatedListResponse[CalendarEventClientReceive]

Response containing a list and next link

Values
array of CalendarEventClientReceive
Values

ClientReceiveMessage

Receive Email Message

Attachments
array of ClientReceiveFileAttachment
The file attachments for the message
BCC
email
The Bcc recipients for the message
Body
string
The body of the message
Body Preview
string
The preview of the message
CC
email
The Cc recipients for the message
Conversation Id
string
The Id of the conversation the email belongs to
From
email
The mailbox owner and sender of the message
Has Attachment
boolean
Indicates whether the message has attachments
Importance
string
The importance of the message
Is HTML
boolean
Is Html?
Is Read
boolean
Indicates whether the message has been read
Message Id
string
The unique identifier of the message
Received Time
date-time
The date and time the message was received
Subject
string
The subject of the message
To
email
The recipients for the message

ClientReceiveFileAttachment

File Attachment

Attachment Id
string
Attachment Id
Content
byte
Attachment content
Content-Type
string
Attachment content type
Name
string
Attachment name

BatchResponse[ClientReceiveMessage]

Represents a wrapper object for batch response

value
array of ClientReceiveMessage
A list of the response objects

TriggerBatchResponse[ClientReceiveMessage]

Represents a wrapper object for batch trigger response

value
array of ClientReceiveMessage
A list of the response objects

ApprovalEmailResponse

Approval Email Response

SelectedOption
string
User response

EntityListResponse[Table]

Entity list response

value
array of Table
List of values

Table

Represents a table.

DisplayName
string
The display name of the table.
DynamicProperties
object
Additional table properties provided by the connector to the clients.
Name
string
The name of the table. The name is used at runtime.

EntityListResponse[CalendarEventBackend]

Entity list response

value
array of CalendarEventBackend
List of values

EntityListResponse[CalendarEventClientReceive]

Entity list response

value
array of CalendarEventClientReceive
List of values

CalendarEventListWithActionType

The list of calendar items with action type

value
array of CalendarEventClientWithActionType
List of calendar items

CalendarEventClientWithActionType

Calendar event model with action type

Action Type
string
Changed action type of the event - added, updated or deleted.
Body
string
Body of the message associated with the event
Created time
date-time
The date and time that the event was created
End time
date-time
End time of the event (example: '2016-11-01T15:30:00')
Id
string
The event's unique identifier
Importance
string
The importance of the event: Low, Normal, or High
Is HTML
boolean
Set to true if the body is Html
Is all day event?
boolean
Set to true if the event lasts all day
Last modified time
date-time
The date and time that the event was last modified
Location
string
Location of the event
Number of occurrences
integer
How many times to repeat the event
Optional attendees
email
Optional attendees for the event separated by semicolons
Organizer
email
The organizer of the event
Recurrence
string
The recurrence pattern for the event
Recurrence end time
date-time
End time of the recurrence
Reminder
integer
Time in minutes before event start to remind
Required attendees
email
Required attendees for the event separated by semicolons
Response requested
boolean
Set to true if the sender would like a response when the event is accepted or declined
Series master id
string
Unique identifier for Series Master event type
Show as
string
Status to show during the event
Start time
date-time
Start time of the event (example: '2016-11-01T14:30:00')
Subject
string
Event subject
Time zone
string
Time zone of the event

EntityListResponse[Contact]

Entity list response

value
array of Contact
List of values

Contact

Contact

Assistant name
string
The name of the contact's assistant
Birthday
date-time
The contact's birthday
Business home page
string
The business home page of the contact
Business phones
array of string
The contact's business phone numbers
BusinessAddress
PhysicalAddress
Contact
Categories
array of string
The categories associated with the contact
Change key
string
Identifies the version of the event object
Company name
string
The name of the contact's company
Created time
date-time
The time the contact was created
Department
string
The contact's department
Display Name
string
The contact's display name
Email addresses
array of EmailAddress
The contact's email addresses
File as
string
The name the contact is filed under
Generation
string
The contact's generation
Given name
string
The contact's given name
Home phones
array of string
The contact's home phone numbers
HomeAddress
PhysicalAddress
Contact
IM addresses
array of string
The contact's instant messaging (IM) addresses
Id
string
The contact's unique identifier.
Initials
string
The contact's initials
JobTitle
string
The contact's job title
Last modified time
date-time
The time the contact was modified
Manager
string
The name of the contact's manager
Middle name
string
The contact's middle name
Mobile phone
string
The contact's mobile phone number
Nickname
string
The contact's nickname
Office location
string
The location of the contact's office
OtherAddress
PhysicalAddress
Contact
Parent folder id
string
The ID of the contact's parent folder
Profession
string
The contact's profession
Surname
string
The contact's surname
Title
string
The contact's title
Yomi company name
string
The phonetic Japanese company name of the contact
Yomi given name
string
The phonetic Japanese given name (first name) of the contact
Yomi surname
string
The phonetic Japanese surname (last name) of the contact