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

Operation ID:
ContactPostItem

This operation creates a new contact in a contacts folder.

Required Parameters

Folder id
string
Select a contacts folder
Key:
table
Given name
string
The contact's given name
Key:
GivenName

Optional Parameters

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

Returns

Body
ContactResponse

Contact response

Create event (V1) [DEPRECATED]

Operation ID:
CalendarPostItem

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

Required Parameters

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

Optional Parameters

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

Returns

Body
CalendarEventBackend

Connector specific calendar event model class for the backend

Create event (V2)

Operation ID:
V2CalendarPostItem

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

Required Parameters

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

Optional Parameters

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

Returns

Body
CalendarEventClientReceiveStringEnums

Connector specific calendar event model class for the client

Delete contact

Operation ID:
ContactDeleteItem

This operation deletes a contact from a contacts folder.

Required Parameters

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

Returns

Body
ContactResponse

Contact response

Delete email

Operation ID:
DeleteEmail

This operation deletes an email by id.

Required Parameters

Message Id
string
Id of the email to delete.
Key:
messageId

Returns

Body
ContactResponse

Contact response

Delete event

Operation ID:
CalendarDeleteItem

This operation deletes an event in a calendar.

Required Parameters

Calendar id
string
Select a calendar
Key:
table
Id
string
Select an event
Key:
id

Returns

Body
ContactResponse

Contact response

Flag email

Operation ID:
Flag

This operation flags an email.

Required Parameters

Message Id
string
Id of the email to be flagged.
Key:
messageId

Returns

Body
ContactResponse

Contact response

Forward an email

Operation ID:
ForwardEmail

Forward an email.

Required Parameters

Message Id
string
Id of the message to forward.
Key:
message_id
To
string
Semicolon separated list of recipients to forward the message to
Key:
ToRecipients

Optional Parameters

Comment
string
Comment
Key:
Comment

Returns

Body
ContactResponse

Contact response

Get attachment

Operation ID:
GetAttachment

This operation gets an email attachment by id.

Required Parameters

Message Id
string
Id of the email.
Key:
messageId
Attachment Id
string
Id of the attachment to download.
Key:
attachmentId

Returns

Body
ContactResponse

Contact response

Get calendar view of events (V2)

Operation ID:
GetEventsCalendarViewV2

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

Required Parameters

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

Optional Parameters

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

Returns

Body
EntityListResponse[CalendarEventClientReceiveStringEnums]

Entity list response

Get calendar view of events [DEPRECATED]

Operation ID:
GetEventsCalendarView

Get calendar view of events.

Required Parameters

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

Returns

Body
PaginatedListResponse[CalendarEventClientReceiveStringEnums]

Response containing a list and next link

Get calendars

Operation ID:
CalendarGetTables

This operation lists available calendars.

Required Parameters

Folder id
string
Select a contacts folder
Key:
table
Given name
string
The contact's given name
Key:
GivenName

Optional Parameters

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

Returns

Body
EntityListResponse[Table]

Entity list response

Get contact

Operation ID:
ContactGetItem

This operation gets a specific contact from a contacts folder.

Required Parameters

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

Returns

Body
ContactResponse

Contact response

Get contact folders

Operation ID:
ContactGetTables

This operation lists available contacts folders.

Required Parameters

Folder id
string
Select a contacts folder
Key:
table
Given name
string
The contact's given name
Key:
GivenName

Optional Parameters

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

Returns

Body
EntityListResponse[Table]

Entity list response

Get contacts

Operation ID:
ContactGetItems

This operation gets contacts from a contacts folder.

Required Parameters

Folder id
string
Unique identifier of the contacts folder to retrieve
Key:
table

Optional Parameters

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

Returns

Body
EntityListResponse[ContactResponse]

Entity list response

Get email

Operation ID:
GetEmail

This operation gets an email by id.

Required Parameters

Message Id
string
Id of the email.
Key:
messageId

Optional Parameters

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

Returns

Body
ClientReceiveMessage

Receive Email Message

Get emails

Operation ID:
GetEmails

This operation gets emails from a folder.

Optional Parameters

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

Returns

array of ClientReceiveMessageStringEnums

Get emails (V2)

Operation ID:
GetEmailsV2

This operation gets emails from a folder.

Optional Parameters

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

Returns

Body
BatchResponse[ClientReceiveMessage]

Represents a wrapper object for batch response

Get event (V1) [DEPRECATED]

Operation ID:
CalendarGetItem

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

Required Parameters

Calendar id
string
Select a calendar
Key:
table
Item id
string
Select an event
Key:
id

Returns

Body
CalendarEventBackend

Connector specific calendar event model class for the backend

Get event (V2)

Operation ID:
V2CalendarGetItem

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

Required Parameters

Calendar id
string
Select a calendar
Key:
table
Item id
string
Select an event
Key:
id

Returns

Body
CalendarEventClientReceiveStringEnums

Connector specific calendar event model class for the client

Get events (V1) [DEPRECATED]

Operation ID:
CalendarGetItems

This operation gets events from a calendar. (V1)

Required Parameters

Calendar id
string
Select a calendar
Key:
table

Optional Parameters

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

Returns

Body
EntityListResponse[CalendarEventBackend]

Entity list response

Get events (V2)

Operation ID:
V2CalendarGetItems

This operation gets events from a calendar. (V2)

Required Parameters

Calendar id
string
Select a calendar
Key:
table

Optional Parameters

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

Returns

Body
EntityListResponse[CalendarEventClientReceiveStringEnums]

Entity list response

Mark as read

Operation ID:
MarkAsRead

This operation marks an email as having been read.

Required Parameters

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

Returns

Body
ContactResponse

Contact response

Move email

Operation ID:
Move

This operation moves an email to the specified folder.

Required Parameters

Message Id
string
Id of the email to be moved.
Key:
messageId
Folder
string
Mail folder to move the email to.
Key:
folderPath

Returns

Body
ContactResponse

Contact response

Reply to email

Operation ID:
ReplyTo

This operation replies to an email.

Required Parameters

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

Optional Parameters

Reply All
boolean
Reply to all recipients.
Key:
replyAll

Returns

Body
ContactResponse

Contact response

Reply to email (V2)

Operation ID:
ReplyToV2

This operation replies to an email.

Required Parameters

Message Id
string
Id of the email to reply to.
Key:
messageId
Name
string
Attachment name
Key:
Name
Content
byte
Attachment content
Key:
ContentBytes

Optional Parameters

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

Returns

Body
ContactResponse

Contact response

Respond to an event invite

Operation ID:
RespondToEvent

Respond to an event invite.

Required Parameters

Event Id
string
Id of the event to respond to.
Key:
event_id
Response
string
Response for the event invite
Key:
response

Optional Parameters

Comment
string
Comment
Key:
Comment
Send response?
boolean
Send response to organizer?
Key:
SendResponse

Returns

Body
ContactResponse

Contact response

Send an email

Operation ID:
SendEmail

This operation sends an email message.

Required Parameters

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

Optional Parameters

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

Returns

Body
ContactResponse

Contact response

Send an email (V2)

Operation ID:
SendEmailV2

This operation sends an email message.

Required Parameters

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

Optional Parameters

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

Returns

Body
ContactResponse

Contact response

Send approval email

Operation ID:
SendApprovalMail

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
Key:
To
Name
string
Attachment name
Key:
Name
Content
byte
Attachment content
Key:
ContentBytes

Optional Parameters

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

Returns

Body
ApprovalEmailResponse

Approval Email Response

Send email with options

Operation ID:
SendMailWithOptions

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
Key:
To
Name
string
Attachment name
Key:
Name
Content
byte
Attachment content
Key:
ContentBytes

Optional Parameters

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

Returns

Body
ApprovalEmailResponse

Approval Email Response

Update contact

Operation ID:
ContactPatchItem

This operation updates a contact in a contacts folder.

Required Parameters

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

Optional Parameters

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

Returns

Body
ContactResponse

Contact response

Update event (V1) [DEPRECATED]

Operation ID:
CalendarPatchItem

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

Required Parameters

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

Optional Parameters

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

Returns

Body
CalendarEventBackend

Connector specific calendar event model class for the backend

Update event (V2)

Operation ID:
V2CalendarPatchItem

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

Required Parameters

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

Optional Parameters

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

Returns

Body
CalendarEventClientReceiveStringEnums

Connector specific calendar event model class for the client

Triggers

When a new email arrives

Operation ID:
OnNewEmail

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.
Key:
folderPath
To
email
Recipient email addresses separated by semicolons (If any match, the trigger will run).
Key:
to
CC
email
CC recipient email addresses separated by semicolons (If any match, the trigger will run).
Key:
cc
To or CC
email
To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).
Key:
toOrCc
From
email
Sender email addresses separated by semicolons (If any match, the trigger will run).
Key:
from
Importance
string
Importance of the email (Any, High, Normal, Low).
Key:
importance
Has Attachment
boolean
Should the email contain attachments.
Key:
fetchOnlyWithAttachment
Include Attachments
boolean
Should the response of the trigger include the attachments.
Key:
includeAttachments
Subject Filter
string
String to look for in the subject line.
Key:
subjectFilter

Returns

Body
TriggerBatchResponse[ClientReceiveMessage]

Represents a wrapper object for batch trigger response

When a new email mentioning me arrives

Operation ID:
OnNewMentionMeEmail

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.
Key:
folderPath
To
email
Recipient email addresses separated by semicolons (If any match, the trigger will run).
Key:
to
CC
email
CC recipient email addresses separated by semicolons (If any match, the trigger will run).
Key:
cc
To or CC
email
To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).
Key:
toOrCc
From
email
Sender email addresses separated by semicolons (If any match, the trigger will run).
Key:
from
Importance
string
Importance of the email (Any, High, Normal, Low).
Key:
importance
Has Attachment
boolean
Should the email contain attachments.
Key:
fetchOnlyWithAttachment
Include Attachments
boolean
Should the response of the trigger include the attachments.
Key:
includeAttachments
Subject Filter
string
String to look for in the subject line.
Key:
subjectFilter

Returns

Body
TriggerBatchResponse[ClientReceiveMessage]

Represents a wrapper object for batch trigger response

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

Operation ID:
CalendarGetOnNewItems

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

Required Parameters

Calendar id
string
Select a calendar
Key:
table

Optional Parameters

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

Returns

Body
CalendarEventList

The list of calendar items

When a new event is created (V2)

Operation ID:
CalendarGetOnNewItemsV2

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

Required Parameters

Calendar id
string
Select a calendar
Key:
table

Optional Parameters

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

Returns

Body
CalendarEventListClientReceive

The list of calendar items

When an email is flagged

Operation ID:
OnFlaggedEmail

This operation triggers a flow when an email is flagged.

Optional Parameters

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

Returns

Body
TriggerBatchResponse[ClientReceiveMessage]

Represents a wrapper object for batch trigger response

When an event is added, updated or deleted

Operation ID:
CalendarGetOnChangedItems

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

Required Parameters

Calendar id
string
Select a calendar
Key:
table

Optional Parameters

Incoming Days Tracked
integer
Number of incoming days in calendar to be tracked
Key:
incomingDays
Past Days Tracked
integer
Number of past days in calendar to be tracked
Key:
pastDays

Returns

Body
CalendarEventListWithActionType

The list of calendar items with action type

When an event is modified (V1) [DEPRECATED]

Operation ID:
CalendarGetOnUpdatedItems

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

Required Parameters

Calendar id
string
Select a calendar
Key:
table

Optional Parameters

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

Returns

Body
CalendarEventList

The list of calendar items

When an event is modified (V2)

Operation ID:
CalendarGetOnUpdatedItemsV2

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

Required Parameters

Calendar id
string
Select a calendar
Key:
table

Optional Parameters

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

Returns

Body
CalendarEventListClientReceive

The list of calendar items

When an upcoming event is starting soon (V2)

Operation ID:
OnUpcomingEventsV2

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

Required Parameters

Calendar Id
string
Unique identifier of the calendar.
Key:
table

Optional Parameters

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

Returns

Body
CalendarEventListClientReceive

The list of calendar items

When an upcoming event is starting soon [DEPRECATED]

Operation ID:
OnUpcomingEvents

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

Required Parameters

Calendar Id
string
Unique identifier of the calendar.
Key:
table

Optional Parameters

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

Returns

Body
CalendarEventList

The list of calendar items

Definitions

CalendarEventList

The list of calendar items

value
array of CalendarEventBackend
List of calendar items
Path:
value

CalendarEventBackend

Connector specific calendar event model class for the backend

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

Attendee

EmailAddress
EmailAddress
Path:
EmailAddress
Status
ResponseStatus
Path:
Status
Type
string
Path:
Type

ItemBody

Content
string
Path:
Content
ContentType
string
Path:
ContentType

Location

Address
PhysicalAddress
Path:
Address
Coordinates
GeoCoordinates
Path:
Coordinates
DisplayName
string
Path:
DisplayName

Recipient

EmailAddress
EmailAddress
Path:
EmailAddress

PatternedRecurrence

Pattern
RecurrencePattern
Path:
Pattern
Range
RecurrenceRange
Path:
Range

ResponseStatus

Response
string
Path:
Response
Time
date-time
Path:
Time

EmailAddress

Address
email
Path:
Address
Name
string
Path:
Name

PhysicalAddress

City
string
Path:
City
CountryOrRegion
string
Path:
CountryOrRegion
PostalCode
string
Path:
PostalCode
State
string
Path:
State
Street
string
Path:
Street

GeoCoordinates

Accuracy
double
Path:
Accuracy
Altitude
double
Path:
Altitude
AltitudeAccuracy
double
Path:
AltitudeAccuracy
Latitude
double
Path:
Latitude
Longitude
double
Path:
Longitude

RecurrencePattern

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

RecurrenceRange

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

CalendarEventListClientReceive

The list of calendar items

value
array of CalendarEventClientReceive
List of calendar items
Path:
value

CalendarEventClientReceive

Connector specific calendar event model class for the client

Body
string
Body of the message associated with the event
Path:
Body
Categories
array of string
The categories associated with the event
Path:
Categories
Created time
date-time
The date and time that the event was created
Path:
DateTimeCreated
End time
date-time
End time of the event (example: '2016-11-01T15:30:00')
Path:
End
Id
string
The event's unique identifier
Path:
Id
Importance
integer
The importance of the event (0 – Low, 1 – Normal, 2 - High)
Path:
Importance
Is HTML
boolean
Set to true if the body is Html
Path:
IsHtml
Is all day event?
boolean
Set to true if the event lasts all day
Path:
IsAllDay
Last modified time
date-time
The date and time that the event was last modified
Path:
DateTimeLastModified
Location
string
Location of the event
Path:
Location
Number of occurrences
integer
How many times to repeat the event
Path:
NumberOfOccurrences
Optional attendees
email
Optional attendees for the event separated by semicolons
Path:
OptionalAttendees
Organizer
email
The organizer of the event
Path:
Organizer
Recurrence
integer
The recurrence pattern for the event (None - 0, Daily - 1, Weekly - 2, Monthly - 3, Yearly - 4)
Path:
Recurrence
Recurrence end time
date-time
End time of the recurrence
Path:
RecurrenceEnd
Reminder
integer
Time in minutes before event start to remind
Path:
Reminder
Required attendees
email
Required attendees for the event separated by semicolons
Path:
RequiredAttendees
Response requested
boolean
Set to true if the sender would like a response when the event is accepted or declined
Path:
ResponseRequested
Series master id
string
Unique identifier for Series Master event type
Path:
SeriesMasterId
Show as
integer
Status to show during the event (Unknown - -1, Free - 0, Tentative - 1, Busy - 2, Oof - 3, WorkingElsewhere - 4)
Path:
ShowAs
Start time
date-time
Start time of the event (example: '2016-11-01T14:30:00')
Path:
Start
Subject
string
Event subject
Path:
Subject
Time zone
string
Time zone of the event
Path:
TimeZone

PaginatedListResponse[CalendarEventClientReceiveStringEnums]

Response containing a list and next link

Values
array of CalendarEventClientReceiveStringEnums
Values
Path:
Values

CalendarEventClientReceiveStringEnums

Connector specific calendar event model class for the client

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

ClientReceiveMessageStringEnums

Receive Email Message

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

ClientReceiveFileAttachment

File Attachment

Attachment Id
string
Attachment Id
Path:
Id
Content
byte
Attachment content
Path:
ContentBytes
Content-Type
string
Attachment content type
Path:
ContentType
Name
string
Attachment name
Path:
Name

BatchResponse[ClientReceiveMessage]

Represents a wrapper object for batch response

value
array of ClientReceiveMessage
A list of the response objects
Path:
value

ClientReceiveMessage

Receive Email Message

Attachments
array of ClientReceiveFileAttachment
The file attachments for the message
Path:
Attachments
BCC
email
The Bcc recipients for the message
Path:
Bcc
Body
string
The body of the message
Path:
Body
Body Preview
string
The preview of the message
Path:
BodyPreview
CC
email
The Cc recipients for the message
Path:
Cc
Conversation Id
string
The Id of the conversation the email belongs to
Path:
ConversationId
From
email
The mailbox owner and sender of the message
Path:
From
Has Attachment
boolean
Indicates whether the message has attachments
Path:
HasAttachment
Importance
integer
The importance of the message (0 – Low, 1 – Normal, 2 - High)
Path:
Importance
Is HTML
boolean
Is Html?
Path:
IsHtml
Is Read
boolean
Indicates whether the message has been read
Path:
IsRead
Message Id
string
The unique identifier of the message
Path:
Id
Received Time
date-time
The date and time the message was received
Path:
DateTimeReceived
Subject
string
The subject of the message
Path:
Subject
To
email
The recipients for the message
Path:
To

TriggerBatchResponse[ClientReceiveMessage]

Represents a wrapper object for batch trigger response

value
array of ClientReceiveMessage
A list of the response objects
Path:
value

ApprovalEmailResponse

Approval Email Response

SelectedOption
string
User response
Path:
SelectedOption

EntityListResponse[Table]

Entity list response

value
array of Table
List of values
Path:
value

Table

Represents a table.

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

EntityListResponse[CalendarEventBackend]

Entity list response

value
array of CalendarEventBackend
List of values
Path:
value

EntityListResponse[CalendarEventClientReceiveStringEnums]

Entity list response

value
array of CalendarEventClientReceiveStringEnums
List of values
Path:
value

CalendarEventListWithActionType

The list of calendar items with action type

value
array of CalendarEventClientWithActionType
List of calendar items
Path:
value

CalendarEventClientWithActionType

Calendar event model with action type

Action Type
string
Changed action type of the event - added, updated or deleted.
Path:
ActionType
Body
string
Body of the message associated with the event
Path:
Body
Categories
array of string
The categories associated with the event
Path:
Categories
Created time
date-time
The date and time that the event was created
Path:
DateTimeCreated
End time
date-time
End time of the event (example: '2016-11-01T15:30:00')
Path:
End
Id
string
The event's unique identifier
Path:
Id
Importance
integer
The importance of the event (0 – Low, 1 – Normal, 2 - High)
Path:
Importance
Is HTML
boolean
Set to true if the body is Html
Path:
IsHtml
Is all day event?
boolean
Set to true if the event lasts all day
Path:
IsAllDay
Last modified time
date-time
The date and time that the event was last modified
Path:
DateTimeLastModified
Location
string
Location of the event
Path:
Location
Number of occurrences
integer
How many times to repeat the event
Path:
NumberOfOccurrences
Optional attendees
email
Optional attendees for the event separated by semicolons
Path:
OptionalAttendees
Organizer
email
The organizer of the event
Path:
Organizer
Recurrence
integer
The recurrence pattern for the event (None - 0, Daily - 1, Weekly - 2, Monthly - 3, Yearly - 4)
Path:
Recurrence
Recurrence end time
date-time
End time of the recurrence
Path:
RecurrenceEnd
Reminder
integer
Time in minutes before event start to remind
Path:
Reminder
Required attendees
email
Required attendees for the event separated by semicolons
Path:
RequiredAttendees
Response requested
boolean
Set to true if the sender would like a response when the event is accepted or declined
Path:
ResponseRequested
Series master id
string
Unique identifier for Series Master event type
Path:
SeriesMasterId
Show as
integer
Status to show during the event (Unknown - -1, Free - 0, Tentative - 1, Busy - 2, Oof - 3, WorkingElsewhere - 4)
Path:
ShowAs
Start time
date-time
Start time of the event (example: '2016-11-01T14:30:00')
Path:
Start
Subject
string
Event subject
Path:
Subject
Time zone
string
Time zone of the event
Path:
TimeZone

EntityListResponse[ContactResponse]

Entity list response

value
array of ContactResponse
List of values
Path:
value

ContactResponse

Contact response

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