Office 365 Outlook

Microsoft Office 365 is a cloud-based service that is designed to help meet your organization's needs for robust security, reliability, and user productivity.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions
Flow Standard All Flow regions
PowerApps Standard All PowerApps regions

To use this connector in PowerApps, learn more here.

Known Issues and Limitations

To use this integration, you will need access to an O365 mailbox that has the REST API enabled. To make a connection, select Sign In. You will be prompted to provide your O365 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. Your administrator can learn how to migrate a mailbox here. Additionally, if you are using an EWS application access policy, please ensure that the following user-agents are whitelisted: "LogicAppsDesigner/*","azure-logic-apps/*","PowerApps/*", "Mozilla/*"

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

When sending emails with options or approval emails, action card (actionable message) rendering in Outlook will not support HTML in the body message. The rendering behavior depends on the option Use only HTML message:

Throttling limits on the Office side

In addittion to the throttling limits per connection, office imposes their own limits per inbox. This limit can be reached if the user creates different Flows/LogicApps that target the same inbox. Here are the documented limits: https://developer.microsoft.com/en-us/office/blogs/throttling-changes-coming-to-beta-outlook-apis-and-outlook-related-apis-in-microsoft-graph/

Deprecation of Webhook Trigger

Due to a recent change in the lifecycle of webhook subscriptions, the When a new email arrives (webhook) trigger has been deprecated. While we are working to provide a solution to this, please use the When a new email arrives polling trigger instead.

General Limits

Name Value
Maximum mails content length (in MB) 49
Maximum number of options for options and approval mails 100

Throttling Limits

Name Calls Renewal Period
API calls per connection90060 seconds

Actions

Create contact

This operation creates a new contact in a contacts folder.

Create contact (V2)

This operation creates a new contact in a contacts folder.

Create event (V1) [DEPRECATED]

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

Create event (V2) [DEPRECATED]

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

Create event (V3)

This operation creates a new event in a calendar.

Create event (V4)

This operation creates a new event in a calendar.

Delete contact

This operation deletes a contact from a contacts folder.

Delete contact (V2)

This operation deletes a contact from a contacts folder.

Delete email

This operation deletes an email by id.

Delete email (V2)

This operation deletes an email by id.

Delete event

This operation deletes an event in a calendar.

Delete event (V2)

This operation deletes an event in a calendar.

Export email

Export the content of the email.

Export email (V2)

Export the content of the email.

Find meeting times

Find meeting time suggestions based on organizer, attendee availability, and time or location constraints

Find meeting times (V2)

Find meeting time suggestions based on organizer, attendee availability, and time or location constraints

Flag email

This operation flags an email.

Flag email (V2)

This operation updates an email flag.

Forward an email

Forward an email.

Forward an email (V2)

Forward an email.

Get attachment

This operation gets an email attachment by id.

Get Attachment (V2)

This operation gets an email attachment by id.

Get calendar view of events (V2)

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

Get calendar view of events (V3)

This operation gets all events (including instances of recurrences) in a calendar using Graph API. (V3)

Get calendar view of events [DEPRECATED]

Get calendar view of events.

Get calendars

This operation lists available calendars.

Get calendars (V2)

This operation lists available calendars.

Get contact

This operation gets a specific contact from a contacts folder.

Get contact (V2)

This operation gets a specific contact from a contacts folder.

Get contact folders

This operation lists available contacts folders.

Get contact folders (V2)

This operation lists available contacts folders using Graph API

Get contacts

This operation gets contacts from a contacts folder.

Get contacts (V2)

This operation gets contacts from a contacts folder.

Get email

This operation gets an email by id.

Get email (V2)

This operation gets an email by id.

Get emails

This operation gets emails from a folder.

Get emails (V2) [DEPRECATED]

This operation gets emails from a folder.

Get emails (V3)

This operation gets emails from a folder via graph apis.

Get event (V1) [DEPRECATED]

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

Get event (V2)

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

Get event (V3)

This operation gets a specific event from a calendar using Graph API. (V3)

Get events (V1) [DEPRECATED]

This operation gets events from a calendar. (V1)

Get events (V2) [DEPRECATED]

This operation gets events from a calendar. (V2)

Get events (V3)

This operation gets events from a calendar. (V3)

Get events (V4)

This operation gets events from a calendar using Graph API. (V4)

Get mail tips for a mailbox

Get mail tips for a mailbox such as automatic replies / OOF message or if the mailbox is full.

Get mail tips for a mailbox (V2)

Get mail tips for a mailbox such as automatic replies / OOF message or if the mailbox is full.

Get room lists

Get all the room lists defined in the user's tenant

Get room lists (V2)

Get all the room lists defined in the user's tenant

Get rooms

Get all the meeting rooms defined in the user's tenant

Get rooms (V2)

Get all the meeting rooms defined in the user's tenant

Get rooms in room list

Get the meeting rooms in a specific room list

Get rooms in room list (V2)

Get the meeting rooms in a specific room list

Mark as read

This operation marks an email as having been read.

Mark as read or unread (V2)

This operation marks an email as read/unread.

Move email

This operation moves an email to the specified folder.

Move email (V2)

This operation moves an email to the specified folder.

Reply to email (V2)

This operation replies to an email.

Reply to email (V3)

This operation replies to an email.

Reply to email [DEPRECATED]

This operation replies to an email.

Respond to an event invite

Respond to an event invite.

Respond to an event invite (V2)

Respond to an event invite.

Send an email

This operation sends an email message.

Send an email (V2)

This operation sends an email message.

Send an email from a shared mailbox

This operation sends an email from a shared mailbox. Your account should have permission to access the mailbox for this operation to succeed.

Send an email from a shared mailbox (V2)

This operation sends an email from a shared mailbox. Your account should have permission to access the mailbox for this operation to succeed.

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.

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.

Set up automatic replies

Set the automatic replies setting for your mailbox.

Set up automatic replies (V2)

Set the automatic replies setting for your mailbox.

Update contact

This operation updates a contact in a contacts folder.

Update contact (V2)

This operation updates a contact in a contacts folder.

Update event (V1) [DEPRECATED]

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

Update event (V2) [DEPRECATED]

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

Update event (V3)

This operation updates an event in a calendar.

Update event (V4)

This operation updates an event in a calendar using Graph API.

Create contact

This operation creates a new contact in a contacts folder.

Parameters

Name Key Required Type Description
Folder id
table True string

Select a contacts folder

Id
Id string

The contact's unique identifier.

Parent folder id
ParentFolderId string

The ID of the contact's parent folder

Birthday
Birthday date-time

The contact's birthday

File as
FileAs string

The name the contact is filed under

Display Name
DisplayName string

The contact's display name

Given name
GivenName True string

The contact's given name

Initials
Initials string

The contact's initials

Middle name
MiddleName string

The contact's middle name

Nickname
NickName string

The contact's nickname

Surname
Surname string

The contact's surname

Title
Title string

The contact's title

Generation
Generation string

The contact's generation

Name
Name string

Select a contacts folder

Address
Address email

Select a contacts folder

IM addresses
IM addresses string

Select a contacts folder

JobTitle
JobTitle string

The contact's job title

Company name
CompanyName string

The name of the contact's company

Department
Department string

The contact's department

Office location
OfficeLocation string

The location of the contact's office

Profession
Profession string

The contact's profession

Business home page
BusinessHomePage string

The business home page of the contact

Assistant name
AssistantName string

The name of the contact's assistant

Manager
Manager string

The name of the contact's manager

Home phones
Home phones string

Select a contacts folder

Business phones
Business phones string

Select a contacts folder

Mobile phone
MobilePhone1 string

The contact's mobile phone number

Street
Street string

Select a contacts folder

City
City string

Select a contacts folder

State
State string

Select a contacts folder

CountryOrRegion
CountryOrRegion string

Select a contacts folder

PostalCode
PostalCode string

Select a contacts folder

Street
Street string

Select a contacts folder

City
City string

Select a contacts folder

State
State string

Select a contacts folder

CountryOrRegion
CountryOrRegion string

Select a contacts folder

PostalCode
PostalCode string

Select a contacts folder

Street
Street string

Select a contacts folder

City
City string

Select a contacts folder

State
State string

Select a contacts folder

CountryOrRegion
CountryOrRegion string

Select a contacts folder

PostalCode
PostalCode string

Select a contacts folder

Yomi company name
YomiCompanyName string

The phonetic Japanese company name of the contact

Yomi given name
YomiGivenName string

The phonetic Japanese given name (first name) of the contact

Yomi surname
YomiSurname string

The phonetic Japanese surname (last name) of the contact

Categories
Categories string

Select a contacts folder

Change key
ChangeKey string

Identifies the version of the event object

Created time
DateTimeCreated date-time

The time the contact was created

Last modified time
DateTimeLastModified date-time

The time the contact was modified

Returns

Contact response

Create contact (V2)

This operation creates a new contact in a contacts folder.

Parameters

Name Key Required Type Description
Folder id
folder True string

Select a contacts folder

Id
id string

The contact's unique identifier.

Parent folder id
parentFolderId string

The ID of the contact's parent folder

Birthday
birthday date-time

The contact's birthday

File as
fileAs string

The name the contact is filed under

Display Name
displayName string

The contact's display name

Given name
givenName True string

The contact's given name

Initials
initials string

The contact's initials

Middle name
middleName string

The contact's middle name

Nickname
nickName string

The contact's nickname

Surname
surname string

The contact's surname

Title
title string

The contact's title

Generation
generation string

The contact's generation

name
name string

Select a contacts folder

address
address email

Select a contacts folder

IM addresses
IM addresses string

Select a contacts folder

JobTitle
jobTitle string

The contact's job title

Company name
companyName string

The name of the contact's company

Department
department string

The contact's department

Office location
officeLocation string

The location of the contact's office

Profession
profession string

The contact's profession

Business home page
businessHomePage string

The business home page of the contact

Assistant name
assistantName string

The name of the contact's assistant

Manager
manager string

The name of the contact's manager

Home phones
Home phones string

Select a contacts folder

Business phones
Business phones string

Select a contacts folder

Mobile phone
mobilePhone string

The contact's mobile phone number

street
street string

Select a contacts folder

city
city string

Select a contacts folder

state
state string

Select a contacts folder

countryOrRegion
countryOrRegion string

Select a contacts folder

postalCode
postalCode string

Select a contacts folder

street
street string

Select a contacts folder

city
city string

Select a contacts folder

state
state string

Select a contacts folder

countryOrRegion
countryOrRegion string

Select a contacts folder

postalCode
postalCode string

Select a contacts folder

street
street string

Select a contacts folder

city
city string

Select a contacts folder

state
state string

Select a contacts folder

countryOrRegion
countryOrRegion string

Select a contacts folder

postalCode
postalCode string

Select a contacts folder

Yomi company name
yomiCompanyName string

The phonetic Japanese company name of the contact

Yomi given name
yomiGivenName string

The phonetic Japanese given name (first name) of the contact

Yomi surname
yomiSurname string

The phonetic Japanese surname (last name) of the contact

Categories
Categories string

Select a contacts folder

Change key
changeKey string

Identifies the version of the event object

Created time
createdDateTime date-time

The time the contact was created

Last modified time
lastModifiedDateTime date-time

The time the contact was modified

Returns

Contact response

Create event (V1) [DEPRECATED]

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

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Id
Id string

The Event's unique identifier

Response
Response string

Select a calendar

Time
Time date-time

Select a calendar

Type
Type string

Select a calendar

Name
Name string

Select a calendar

Address
Address email

Select a calendar

ContentType
ContentType string

Select a calendar

Content
Content string

Select a calendar

Body preview
BodyPreview string

The preview of the message associated with the event

Categories
Categories string

Select a calendar

Change key
ChangeKey string

This property identifies the version of the event object. Every time the event is changed, ChangeKey changes as well.

Created time
DateTimeCreated date-time

The date and time that the event was created

Last modified time
DateTimeLastModified date-time

The date and time that the event was last modified

End time
End True date-time

The end time of the event

End time zone
EndTimeZone 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?
HasAttachments boolean

Set to true if the event has attachments

Importance
Importance string

The importance of the event: Low, Normal, or High

Is all day event?
IsAllDay boolean

Set to true if the event lasts all day

Is cancelled?
IsCancelled boolean

Set to true if the event has been canceled

Is Organizer
IsOrganizer boolean

Set to true if the message sender is also the organizer

DisplayName
DisplayName string

Select a calendar

Street
Street string

Select a calendar

City
City string

Select a calendar

State
State string

Select a calendar

CountryOrRegion
CountryOrRegion string

Select a calendar

PostalCode
PostalCode string

Select a calendar

Altitude
Altitude double

Select a calendar

Latitude
Latitude double

Select a calendar

Longitude
Longitude double

Select a calendar

Accuracy
Accuracy double

Select a calendar

AltitudeAccuracy
AltitudeAccuracy double

Select a calendar

Name
Name string

Select a calendar

Address
Address email

Select a calendar

Type
Type string

Select a calendar

Interval
Interval integer

Select a calendar

Month
Month integer

Select a calendar

DayOfMonth
DayOfMonth integer

Select a calendar

DaysOfWeek
DaysOfWeek string

Select a calendar

FirstDayOfWeek
FirstDayOfWeek string

Select a calendar

Index
Index string

Select a calendar

Type
Type string

Select a calendar

StartDate
StartDate date-time

Select a calendar

EndDate
EndDate date-time

Select a calendar

NumberOfOccurrences
NumberOfOccurrences integer

Select a calendar

Reminder
Reminder integer

Time in minutes before event start to remind

Response requested
ResponseRequested boolean

Set to true if the sender would like a response when the event is accepted or declined

Response
Response string

Select a calendar

Time
Time date-time

Select a calendar

Series master id
SeriesMasterId string

Unique identifier for Series Master event type

Show as
ShowAs string

Shows as free or busy

Start time
Start True date-time

The start time of the event

Start time zone
StartTimeZone 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
Subject True string

Event subject

Type
Type string

The event type: Single Instance, Occurrence, Exception, or Series Master

Web link
WebLink uri

The preview of the message associated with the event

Reason
Reason string

The reason property used by O365 sync events protocol, will be 'deleted' if its a deleted event.

Returns

Connector specific calendar event model class for the backend

Create event (V2) [DEPRECATED]

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

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Subject
Subject True string

Event subject

Start time
Start True date-time

Start time of the event (example: '2016-11-01T14:30:00Z')

End time
End True date-time

End time of the event (example: '2016-11-01T15:30:00Z')

Time zone
TimeZone string

Time zone of the event

Required attendees
RequiredAttendees email

Required attendees for the event separated by semicolons

Optional attendees
OptionalAttendees email

Optional attendees for the event separated by semicolons

Resource attendees
ResourceAttendees string

Resource attendees for the event separated by semicolons

Body
Body string

Body of the message associated with the event

Is HTML
IsHtml boolean

Set to true if the body is Html

Location
Location string

Location of the event

Importance
Importance string

The importance of the event: Low, Normal, or High

Is all day event?
IsAllDay boolean

Set to true if the event lasts all day

Recurrence
Recurrence string

The recurrence pattern for the event

Recurrence end time
RecurrenceEnd date-time

End time of the recurrence

Number of occurrences
NumberOfOccurrences integer

How many times to repeat the event

Reminder
Reminder integer

Time in minutes before event start to remind

Show as
ShowAs string

Status to show during the event

Response requested
ResponseRequested boolean

Set to true if the sender would like a response when the event is accepted or declined

Returns

Connector specific calendar event model class for the client

Create event (V3)

This operation creates a new event in a calendar.

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Subject
Subject True string

Event subject

Start time
Start True date-time

Start time of the event (example: '2016-11-01T14:30:00Z')

End time
End True date-time

End time of the event (example: '2016-11-01T15:30:00Z')

Time zone
TimeZone string

Time zone of the event

Required attendees
RequiredAttendees email

Required attendees for the event separated by semicolons

Optional attendees
OptionalAttendees email

Optional attendees for the event separated by semicolons

Resource attendees
ResourceAttendees string

Resource attendees for the event separated by semicolons

Body
Body html

Body of the message associated with the event

Location
Location string

Location of the event

Importance
Importance string

The importance of the event: Low, Normal, or High

Is all day event?
IsAllDay boolean

Set to true if the event lasts all day

Recurrence
Recurrence string

The recurrence pattern for the event

Recurrence end time
RecurrenceEnd date-time

End time of the recurrence

Number of occurrences
NumberOfOccurrences integer

How many times to repeat the event

Reminder
Reminder integer

Time in minutes before event start to remind

Show as
ShowAs string

Status to show during the event

Response requested
ResponseRequested boolean

Set to true if the sender would like a response when the event is accepted or declined

Returns

Connector specific calendar event model class for the client

Create event (V4)

This operation creates a new event in a calendar.

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Subject
subject True string

Event subject

Start time
start True date-no-tz

Start time of the event (example: '2017-08-29T04:00:00')

End time
end True date-no-tz

End time of the event (example: '2017-08-29T05:00:00')

Time zone
timeZone True string

Time zone of the event

Required attendees
requiredAttendees email

Required attendees for the event separated by semicolons

Optional attendees
optionalAttendees email

Optional attendees for the event separated by semicolons

Resource attendees
resourceAttendees string

Resource attendees for the event separated by semicolons

Body
body html

Body of the message associated with the event

Location
location string

Location of the event

Importance
importance string

The importance of the event: low, normal, or high

Is all day event?
isAllDay boolean

Set to true if the event lasts all day

Recurrence
recurrence string

The recurrence pattern for the event: none, daily, weekly, monthly or yearly

Recurrence end date
recurrenceEnd date

End date of the recurrence

Number of occurrences
numberOfOccurences integer

How many times to repeat the event

Reminder
reminderMinutesBeforeStart integer

Time in minutes before event start to remind

Show as
showAs string

Status to show during the event: free, tentative, busy, oof, workingElsewhere or unknown

Response requested
responseRequested boolean

Set to true if the sender would like a response when the event is accepted or declined

Returns

Connector specific calendar event model class for the client with Graph API

Delete contact

This operation deletes a contact from a contacts folder.

Parameters

Name Key Required Type Description
Folder id
table True string

Select a contacts folder

Id
id True string

Unique identifier of contact to delete

Delete contact (V2)

This operation deletes a contact from a contacts folder.

Parameters

Name Key Required Type Description
Folder id
folder True string

Select a contacts folder

Id
id True string

Unique identifier of contact to delete

Delete email

This operation deletes an email by id.

Parameters

Name Key Required Type Description
Message Id
messageId True string

Id of the email to delete.

Delete email (V2)

This operation deletes an email by id.

Parameters

Name Key Required Type Description
Message Id
messageId True string

Id of the email to delete.

Delete event

This operation deletes an event in a calendar.

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Id
id True string

Select an event

Delete event (V2)

This operation deletes an event in a calendar.

Parameters

Name Key Required Type Description
Calendar id
calendar True string

Select a calendar

Id
event True string

Select an event

Export email

Export the content of the email.

Parameters

Name Key Required Type Description
Message Id
messageId True string

Id of the email to export.

Export email (V2)

Export the content of the email.

Parameters

Name Key Required Type Description
Message Id
messageId True string

Id of the email to export.

Find meeting times

Find meeting time suggestions based on organizer, attendee availability, and time or location constraints

Parameters

Name Key Required Type Description
Required attendees
RequiredAttendees string

List of semicolon separated email addresses

Optional attendees
OptionalAttendees string

List of semicolon separated email addresses

Resource attendees
ResourceAttendees string

Resource attendees for the event separated by semicolons

Meeting duration
MeetingDuration integer

Duration of the meeting in minutes

Start time
Start date-time

Start time for meeting time suggestions

End time
End date-time

End time for meeting time suggestions

Max Candidates
MaxCandidates integer

The maximum number of meeting suggestions to return in the response

Minimum Attendee Percentage
MinimumAttendeePercentage string

The minimum required confidence for a time slot to be returned in the response

Is Organizer Optional?
IsOrganizerOptional boolean

true if the organizer doesn't have to attend. The default is false

Activity Domain
ActivityDomain string

Work, Personal, Unrestricted, or Unknown

Returns

Name Path Type Description
Empty Suggestions Reason
EmptySuggestionsReason string

Empty Suggestions Reason

Meeting Time Suggestions
MeetingTimeSuggestions MeetingTimeSuggestions

Meeting Time Suggestions

Find meeting times (V2)

Find meeting time suggestions based on organizer, attendee availability, and time or location constraints

Parameters

Name Key Required Type Description
Required attendees
RequiredAttendees string

List of semicolon separated email addresses

Optional attendees
OptionalAttendees string

List of semicolon separated email addresses

Resource attendees
ResourceAttendees string

Resource attendees for the event separated by semicolons

Meeting duration
MeetingDuration integer

Duration of the meeting in minutes

Start time
Start date-time

Start time for meeting time suggestions

End time
End date-time

End time for meeting time suggestions

Max Candidates
MaxCandidates integer

The maximum number of meeting suggestions to return in the response

Minimum Attendee Percentage
MinimumAttendeePercentage string

The minimum required confidence for a time slot to be returned in the response

Is Organizer Optional?
IsOrganizerOptional boolean

true if the organizer doesn't have to attend. The default is false

Activity Domain
ActivityDomain string

Work, Personal, Unrestricted, or Unknown

Returns

Name Path Type Description
Empty Suggestions Reason
emptySuggestionsReason string

Empty Suggestions Reason

Meeting Time Suggestions
meetingTimeSuggestions MeetingTimeSuggestions_V2

Meeting Time Suggestions

Flag email

This operation flags an email.

Parameters

Name Key Required Type Description
Message Id
messageId True string

Id of the email to be flagged.

Flag email (V2)

This operation updates an email flag.

Parameters

Name Key Required Type Description
Message Id
messageId True string

Id of the email to be flagged.

Flag Status
flagStatus string

Flag status

Forward an email

Forward an email.

Parameters

Name Key Required Type Description
Message Id
message_id True string

Id of the message to forward.

Comment
Comment string

Comment

To
ToRecipients True string

Semicolon separated list of recipients to forward the message to

Forward an email (V2)

Forward an email.

Parameters

Name Key Required Type Description
Message Id
message_id True string

Id of the message to forward.

Comment
Comment string

Comment

To
ToRecipients True string

Semicolon separated list of recipients to forward the message to

Get attachment

This operation gets an email attachment by id.

Parameters

Name Key Required Type Description
Message Id
messageId True string

Id of the email.

Attachment Id
attachmentId True string

Id of the attachment to download.

Get Attachment (V2)

This operation gets an email attachment by id.

Parameters

Name Key Required Type Description
Message Id
messageId True string

Id of the email.

Attachement Id
attachmentId True string

Id of the attachment to download.

Returns

Name Path Type Description
Id
id string

Id of the attachment.

Name
name string

Name of attachment.

Content Type
contentType string

Content type of attachment.

Size
size integer

Size of attachment.

Content Bytes
contentBytes binary

Content of attachment.

Get calendar view of events (V2)

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

Parameters

Name Key Required Type Description
Calendar Id
calendarId True string

Select a calendar

Start Time
startDateTimeOffset True string

Start time (example: '2017-01-01T08:00:00-07:00')

End Time
endDateTimeOffset True string

End time (example: '2017-02-01T08:00:00-07:00')

Filter Query
$filter string

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

Order By
$orderby string

An ODATA orderBy query for specifying the order of entries.

Top Count
$top integer

Total number of entries to retrieve (default = all).

Skip Count
$skip integer

The number of entries to skip (default = 0).

Search
search string

Search text for matching event body and subject

Returns

Entity list response

Get calendar view of events (V3)

This operation gets all events (including instances of recurrences) in a calendar using Graph API. (V3)

Parameters

Name Key Required Type Description
Calendar Id
calendarId True string

Select a calendar

Start Time
startDateTimeUtc True string

Start time in UTC (example: '2017-01-01T08:00:00')

End Time
endDateTimeUtc True string

End time in UTC (example: '2017-02-01T08:00:00')

Filter Query
$filter string

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

Order By
$orderby string

An ODATA orderBy query for specifying the order of entries.

Top Count
$top integer

Total number of entries to retrieve (default = all).

Skip Count
$skip integer

The number of entries to skip (default = 0).

Search
search string

Search text for matching event body and subject

Returns

Entity list response

Get calendar view of events [DEPRECATED]

Get calendar view of events.

Parameters

Name Key Required Type Description
Calendar Id
calendarId True string

Select a calendar.

Start Time
startDateTimeOffset True string

Start time (example: '2017-01-01T08:00:00-07:00').

End Time
endDateTimeOffset True string

End time (example: '2017-02-01T08:00:00-07:00').

Returns

Response containing a list and next link

Get calendars

This operation lists available calendars.

Returns

Entity list response

Get calendars (V2)

This operation lists available calendars.

Returns

Name Path Type Description
value
value array of object

value

ID
value.id string

The id of the calendar. The id is used at runtime.

Name
value.name string

The display name of the calendar.

Get contact

This operation gets a specific contact from a contacts folder.

Parameters

Name Key Required Type Description
Folder id
table True string

Select a contacts folder

Item id
id True string

Unique identifier of a contact to retrieve

Returns

Contact response

Get contact (V2)

This operation gets a specific contact from a contacts folder.

Parameters

Name Key Required Type Description
Folder id
folder True string

Select a contacts folder

Item id
id True string

Unique identifier of a contact to retrieve

Returns

Contact response

Get contact folders

This operation lists available contacts folders.

Returns

Entity list response

Get contact folders (V2)

This operation lists available contacts folders using Graph API

Returns

Entity list response

Get contacts

This operation gets contacts from a contacts folder.

Parameters

Name Key Required Type Description
Folder id
table True string

Unique identifier of the contacts folder to retrieve

Filter Query
$filter string

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

Order By
$orderby string

An ODATA orderBy query for specifying the order of entries.

Top Count
$top integer

Total number of entries to retrieve (default = all).

Skip Count
$skip integer

The number of entries to skip (default = 0).

Returns

Entity list response

Get contacts (V2)

This operation gets contacts from a contacts folder.

Parameters

Name Key Required Type Description
Folder id
folder True string

Unique identifier of the contacts folder to retrieve

Filter Query
$filter string

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

Order By
$orderby string

An ODATA orderBy query for specifying the order of entries.

Top Count
$top integer

Total number of entries to retrieve (default = all).

Skip Count
$skip integer

The number of entries to skip (default = 0).

Returns

Entity list response

Get email

This operation gets an email by id.

Parameters

Name Key Required Type Description
Message Id
messageId True string

Id of the email.

Include Attachments
includeAttachments boolean

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

Returns

Receive Email Message

Get email (V2)

This operation gets an email by id.

Parameters

Name Key Required Type Description
Message Id
messageId True string

Id of the email.

Include Attachments
includeAttachments boolean

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

Returns

Graph Client Receive Email Message

Get emails

This operation gets emails from a folder.

Parameters

Name Key Required Type Description
Folder
folderPath string

Mail folder to retrieve emails from (default: 'Inbox').

Fetch Only Unread Messages
fetchOnlyUnread boolean

Retrieve only unread emails?.

Include Attachments
includeAttachments boolean

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

Search Query
searchQuery string

Search query (like in the Outlook client) to filter emails.

Top
top integer

Number of emails to retrieve (default: 10).

Returns

Get emails (V2) [DEPRECATED]

This operation gets emails from a folder.

Parameters

Name Key Required Type Description
Folder
folderPath string

Mail folder to retrieve emails from (default: 'Inbox').

To
to email

Recipient email addresses separated by semicolons (If any match, the trigger will run).

CC
cc email

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

To or CC
toOrCc email

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

From
from email

Sender email addresses separated by semicolons (If any match, the trigger will run).

Importance
importance string

Importance of the email (Any, High, Normal, Low).

Has Attachment
fetchOnlyWithAttachment boolean

Should the email contain attachments.

Subject Filter
subjectFilter string

String to look for in the subject line.

Fetch Only Unread Messages
fetchOnlyUnread boolean

Retrieve only unread emails?.

Include Attachments
includeAttachments boolean

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

Search Query
searchQuery string

Search query (like in the Outlook client) to filter emails.

Top
top integer

Number of emails to retrieve (default: 10).

Returns

Represents a wrapper object for batch response

Get emails (V3)

This operation gets emails from a folder via graph apis.

Parameters

Name Key Required Type Description
Folder
folderPath string

Mail folder to retrieve emails from (default: 'Inbox').

To
to email

Recipient email addresses separated by semicolons (If any match, the trigger will run).

CC
cc email

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

To or CC
toOrCc email

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

From
from email

Sender email addresses separated by semicolons (If any match, the trigger will run).

Importance
importance string

Importance of the email (Any, High, Normal, Low).

Has Attachment
fetchOnlyWithAttachment boolean

Should the email contain attachments.

Subject Filter
subjectFilter string

String to look for in the subject line.

Fetch Only Unread Messages
fetchOnlyUnread boolean

Retrieve only unread emails?.

Include Attachments
includeAttachments boolean

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

Search Query
searchQuery string

Search query (like in the Outlook client) to filter emails.

Top
top integer

Number of emails to retrieve (default: 10).

Returns

Represents a wrapper object for batch response

Get event (V1) [DEPRECATED]

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

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Item id
id True string

Select an event

Returns

Connector specific calendar event model class for the backend

Get event (V2)

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

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Item id
id True string

Select an event

Returns

Connector specific calendar event model class for the client

Get event (V3)

This operation gets a specific event from a calendar using Graph API. (V3)

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Item id
id True string

Select an event

Returns

Connector specific calendar event model class for the client with Graph API

Get events (V1) [DEPRECATED]

This operation gets events from a calendar. (V1)

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Order By
$orderby string

An ODATA orderBy query for specifying the order of entries.

Top Count
$top integer

Total number of entries to retrieve (default = all).

Skip Count
$skip integer

The number of entries to skip (default = 0).

Returns

Entity list response

Get events (V2) [DEPRECATED]

This operation gets events from a calendar. (V2)

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Filter Query
$filter string

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

Order By
$orderby string

An ODATA orderBy query for specifying the order of entries.

Top Count
$top integer

Total number of entries to retrieve (default = all).

Skip Count
$skip integer

The number of entries to skip (default = 0).

Returns

Entity list response

Get events (V3)

This operation gets events from a calendar. (V3)

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Filter Query
$filter string

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

Order By
$orderby string

An ODATA orderBy query for specifying the order of entries.

Top Count
$top integer

Total number of entries to retrieve (default = all).

Skip Count
$skip integer

The number of entries to skip (default = 0).

Returns

The list of calendar items

Get events (V4)

This operation gets events from a calendar using Graph API. (V4)

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Filter Query
$filter string

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

Order By
$orderby string

An ODATA orderBy query for specifying the order of entries.

Top Count
$top integer

Total number of entries to retrieve (default = all).

Skip Count
$skip integer

The number of entries to skip (default = 0).

Returns

The list of calendar items returned by Graph API

Get mail tips for a mailbox

Get mail tips for a mailbox such as automatic replies / OOF message or if the mailbox is full.

Parameters

Name Key Required Type Description
Mailbox Address
mailboxAddress True string

Address of the mailbox to get mail tips for.

Returns

Mail tips client model returned to the caller

Get mail tips for a mailbox (V2)

Get mail tips for a mailbox such as automatic replies / OOF message or if the mailbox is full.

Parameters

Name Key Required Type Description
Email Addresses
Email Addresses string

Get mail tips for a mailbox such as automatic replies / OOF message or if the mailbox is full.

Returns

Mail tips client model returned to the caller

Get room lists

Get all the room lists defined in the user's tenant

Returns

Name Path Type Description
value
value array of object

value

Name
value.Name string

Name

Address
value.Address string

Address

Get room lists (V2)

Get all the room lists defined in the user's tenant

Returns

Name Path Type Description
value
value array of object

value

Name
value.name string

Name

Address
value.address string

Address

Get rooms

Get all the meeting rooms defined in the user's tenant

Returns

Name Path Type Description
value
value array of object

value

Name
value.Name string

Name

Address
value.Address string

Address

Get rooms (V2)

Get all the meeting rooms defined in the user's tenant

Returns

Name Path Type Description
value
value array of object

value

Name
value.name string

Name

Address
value.address string

Address

Get rooms in room list

Get the meeting rooms in a specific room list

Parameters

Name Key Required Type Description
Room list
room_list True string

Room list to find rooms in

Returns

Name Path Type Description
value
value array of object

value

Name
value.Name string

Name

Address
value.Address string

Address

Get rooms in room list (V2)

Get the meeting rooms in a specific room list

Parameters

Name Key Required Type Description
Room list
room_list True string

Room list to find rooms in

Returns

Name Path Type Description
value
value array of object

value

Name
value.name string

Name

Address
value.address string

Address

Mark as read

This operation marks an email as having been read.

Parameters

Name Key Required Type Description
Message Id
messageId True string

Id of the email to be marked as read.

Mark as read or unread (V2)

This operation marks an email as read/unread.

Parameters

Name Key Required Type Description
Message Id
messageId True string

Id of the email to be marked.

Mark as
isRead boolean

Mark as read/unread.

Move email

This operation moves an email to the specified folder.

Parameters

Name Key Required Type Description
Message Id
messageId True string

Id of the email to be moved.

Folder
folderPath True string

Mail folder to move the email to.

Returns

Receive Email Message

Move email (V2)

This operation moves an email to the specified folder.

Parameters

Name Key Required Type Description
Message Id
messageId True string

Id of the email to be moved.

Folder
folderPath True string

Mail folder to move the email to.

Returns

Graph Client Receive Email Message

Reply to email (V2)

This operation replies to an email.

Parameters

Name Key Required Type Description
Message Id
messageId True string

Id of the email to reply to.

To
To email

Example: recipient1@domain.com; recipient2@domain.com

CC
Cc email

Example: recipient1@domain.com; recipient2@domain.com

BCC
Bcc email

Example: recipient1@domain.com; recipient2@domain.com

Subject
Subject string

Email subject (if empty, the original subject used).

Body
Body string

Content of the email.

Reply All
ReplyAll boolean

True to reply to all recipients. (default: False)

Is HTML
IsHtml boolean

True to send the reply as HTML. (default: True)

Importance
Importance string

Pick an importance. (default: Low)

Name
Name True string

Attachment name

Content
ContentBytes True byte

Attachment content

Reply to email (V3)

This operation replies to an email.

Parameters

Name Key Required Type Description
Message Id
messageId True string

Id of the email to reply to.

To
To email

Example: recipient1@domain.com; recipient2@domain.com

CC
Cc email

Example: recipient1@domain.com; recipient2@domain.com

BCC
Bcc email

Example: recipient1@domain.com; recipient2@domain.com

Subject
Subject string

Email subject (if empty, the original subject used).

Body
Body html

Content of the email.

Reply All
ReplyAll boolean

True to reply to all recipients. (default: False)

Importance
Importance string

Pick an importance. (default: Low)

Name
Name True string

Attachment name

Content
ContentBytes True byte

Attachment content

Reply to email [DEPRECATED]

This operation replies to an email.

Parameters

Name Key Required Type Description
Message Id
messageId True string

Id of the email to reply to.

Comment
comment True string

Reply comment.

Reply All
replyAll boolean

Reply to all recipients.

Respond to an event invite

Respond to an event invite.

Parameters

Name Key Required Type Description
Event Id
event_id True string

Id of the event to respond to.

Response
response True string

Response for the event invite

Comment
Comment string

Comment

Send response?
SendResponse boolean

Send response to organizer?

Respond to an event invite (V2)

Respond to an event invite.

Parameters

Name Key Required Type Description
Event Id
event_id True string

Id of the event to respond to.

Response
response True string

Response for the event invite

Comment
Comment string

Comment

Send response?
SendResponse boolean

Send response to organizer?

Send an email

This operation sends an email message.

Parameters

Name Key Required Type Description
From (Send as)
From email

Email address to send mail from (requires "Send as" or "Send on behalf of" permission for that mailbox)

CC
Cc email

Specify email addresses separated by semicolons like someone@contoso.com

BCC
Bcc email

Specify email addresses separated by semicolons like someone@contoso.com

To
To True email

Specify email addresses separated by semicolons like someone@contoso.com

Subject
Subject True string

Specify the subject of the mail

Body
Body True string

Specify the body of the mail

Name
Name True string

Attachment name

Content
ContentBytes True byte

Attachment content

Importance
Importance string

Importance

Is HTML
IsHtml boolean

Is Html?

Send an email (V2)

This operation sends an email message.

Parameters

Name Key Required Type Description
To
To True email

Specify email addresses separated by semicolons like someone@contoso.com

Subject
Subject True string

Specify the subject of the mail

Body
Body True html

Specify the body of the mail

CC
Cc email

Specify email addresses separated by semicolons like someone@contoso.com

BCC
Bcc email

Specify email addresses separated by semicolons like someone@contoso.com

Name
Name True string

Attachment name

Content
ContentBytes True byte

Attachment content

Importance
Importance string

Importance

Send an email from a shared mailbox

This operation sends an email from a shared mailbox. Your account should have permission to access the mailbox for this operation to succeed.

Parameters

Name Key Required Type Description
Mailbox Address
MailboxAddress True email

Specify email address of a shared mailbox like someone@contoso.com

To
To True email

Specify email addresses separated by semicolons like someone@contoso.com

Subject
Subject True string

Specify the subject of the mail

Body
Body True string

Specify the body of the mail

CC
Cc email

Specify email addresses separated by semicolons like someone@contoso.com

BCC
Bcc email

Specify email addresses separated by semicolons like someone@contoso.com

Name
Name True string

Attachment name

Content
ContentBytes True byte

Attachment content

Importance
Importance string

Importance

Is HTML
IsHtml boolean

Is Html?

Send an email from a shared mailbox (V2)

This operation sends an email from a shared mailbox. Your account should have permission to access the mailbox for this operation to succeed.

Parameters

Name Key Required Type Description
Mailbox Address
MailboxAddress True email

Specify email address of a shared mailbox like someone@contoso.com

To
To True email

Specify email addresses separated by semicolons like someone@contoso.com

Subject
Subject True string

Specify the subject of the mail

Body
Body True html

Specify the body of the mail

CC
Cc email

Specify email addresses separated by semicolons like someone@contoso.com

BCC
Bcc email

Specify email addresses separated by semicolons like someone@contoso.com

Name
Name True string

Attachment name

Content
ContentBytes True byte

Attachment content

Importance
Importance string

Importance

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.

Parameters

Name Key Required Type Description
To
To True email

Specify email addresses separated by semicolons like someone@contoso.com

Subject
Subject string

Subject

User Options
Options string

User Options

Header Text
HeaderText string

Header text for email body

Selection Text
SelectionText string

Header text for users options selection

Body
Body string

Body

Importance
Importance string

Importance

Name
Name True string

Attachment name

Content
ContentBytes True byte

Attachment content

Use only HTML message
UseOnlyHTMLMessage boolean

Use only HTML message

Returns

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.

Parameters

Name Key Required Type Description
To
To True email

Specify email addresses separated by semicolons like someone@contoso.com

Subject
Subject string

Subject of the email

User Options
Options string

List of comma separated options for the email response

Header Text
HeaderText string

Header text for email body

Selection Text
SelectionText string

Header text for users options selection

Body
Body string

Body of the email

Importance
Importance string

Importance

Name
Name True string

Attachment name

Content
ContentBytes True byte

Attachment content

Use only HTML message
UseOnlyHTMLMessage boolean

Use only HTML message

Returns

Approval Email Response

Set up automatic replies

Set the automatic replies setting for your mailbox.

Parameters

Name Key Required Type Description
Status
Status True string

Automatic reply setting status

External Audience
ExternalAudience True string

The audience that will see the external reply message

Start Time
ScheduledStartDateTimeOffset string

Scheduled start time (example: '2016-11-01T15:30:00-00:00Z')

End Time
ScheduledEndDateTimeOffset string

Scheduled end time (example: '2016-11-01T15:30:00-00:00Z')

Internal Reply Message
InternalReplyMessage string

Message for people within your organization

External Reply Message
ExternalReplyMessage string

Message for people outside your organization

Set up automatic replies (V2)

Set the automatic replies setting for your mailbox.

Parameters

Name Key Required Type Description
Status
status True string

Automatic reply setting status

External Audience
externalAudience True string

The audience that will see the external reply message

DateTime
dateTime string

Scheduled start time (example: '2017-08-29T04:00:00.0000000')

TimeZone
timeZone string

TimeZone (example: 'Pacific Standard Time')

DateTime
dateTime string

Scheduled end time (example: '2017-08-29T05:00:00.0000000')

TimeZone
timeZone string

TimeZone (example: 'Pacific Standard Time')

Internal Reply Message
internalReplyMessage string

Message for people within your organization

External Reply Message
externalReplyMessage string

Message for people outside your organization

Returns

Name Path Type Description
automaticRepliesSetting
automaticRepliesSetting AutomaticRepliesSettingClient_V2

Automatic replies setting model for the connector

Update contact

This operation updates a contact in a contacts folder.

Parameters

Name Key Required Type Description
Folder id
table True string

Select a contacts folder

Id
id True string

Unique identifier of contact to update

Id
Id string

The contact's unique identifier.

Parent folder id
ParentFolderId string

The ID of the contact's parent folder

Birthday
Birthday date-time

The contact's birthday

File as
FileAs string

The name the contact is filed under

Display Name
DisplayName string

The contact's display name

Given name
GivenName True string

The contact's given name

Initials
Initials string

The contact's initials

Middle name
MiddleName string

The contact's middle name

Nickname
NickName string

The contact's nickname

Surname
Surname string

The contact's surname

Title
Title string

The contact's title

Generation
Generation string

The contact's generation

Name
Name string

Select a contacts folder

Address
Address email

Select a contacts folder

IM addresses
IM addresses string

Select a contacts folder

JobTitle
JobTitle string

The contact's job title

Company name
CompanyName string

The name of the contact's company

Department
Department string

The contact's department

Office location
OfficeLocation string

The location of the contact's office

Profession
Profession string

The contact's profession

Business home page
BusinessHomePage string

The business home page of the contact

Assistant name
AssistantName string

The name of the contact's assistant

Manager
Manager string

The name of the contact's manager

Home phones
Home phones string

Select a contacts folder

Business phones
Business phones string

Select a contacts folder

Mobile phone
MobilePhone1 string

The contact's mobile phone number

Street
Street string

Select a contacts folder

City
City string

Select a contacts folder

State
State string

Select a contacts folder

CountryOrRegion
CountryOrRegion string

Select a contacts folder

PostalCode
PostalCode string

Select a contacts folder

Street
Street string

Select a contacts folder

City
City string

Select a contacts folder

State
State string

Select a contacts folder

CountryOrRegion
CountryOrRegion string

Select a contacts folder

PostalCode
PostalCode string

Select a contacts folder

Street
Street string

Select a contacts folder

City
City string

Select a contacts folder

State
State string

Select a contacts folder

CountryOrRegion
CountryOrRegion string

Select a contacts folder

PostalCode
PostalCode string

Select a contacts folder

Yomi company name
YomiCompanyName string

The phonetic Japanese company name of the contact

Yomi given name
YomiGivenName string

The phonetic Japanese given name (first name) of the contact

Yomi surname
YomiSurname string

The phonetic Japanese surname (last name) of the contact

Categories
Categories string

Select a contacts folder

Change key
ChangeKey string

Identifies the version of the event object

Created time
DateTimeCreated date-time

The time the contact was created

Last modified time
DateTimeLastModified date-time

The time the contact was modified

Returns

Contact response

Update contact (V2)

This operation updates a contact in a contacts folder.

Parameters

Name Key Required Type Description
Folder id
folder True string

Select a contacts folder

Id
id True string

Unique identifier of contact to update

Id
id string

The contact's unique identifier.

Parent folder id
parentFolderId string

The ID of the contact's parent folder

Birthday
birthday date-time

The contact's birthday

File as
fileAs string

The name the contact is filed under

Display Name
displayName string

The contact's display name

Given name
givenName True string

The contact's given name

Initials
initials string

The contact's initials

Middle name
middleName string

The contact's middle name

Nickname
nickName string

The contact's nickname

Surname
surname string

The contact's surname

Title
title string

The contact's title

Generation
generation string

The contact's generation

name
name string

Select a contacts folder

address
address email

Select a contacts folder

IM addresses
IM addresses string

Select a contacts folder

JobTitle
jobTitle string

The contact's job title

Company name
companyName string

The name of the contact's company

Department
department string

The contact's department

Office location
officeLocation string

The location of the contact's office

Profession
profession string

The contact's profession

Business home page
businessHomePage string

The business home page of the contact

Assistant name
assistantName string

The name of the contact's assistant

Manager
manager string

The name of the contact's manager

Home phones
Home phones string

Select a contacts folder

Business phones
Business phones string

Select a contacts folder

Mobile phone
mobilePhone string

The contact's mobile phone number

street
street string

Select a contacts folder

city
city string

Select a contacts folder

state
state string

Select a contacts folder

countryOrRegion
countryOrRegion string

Select a contacts folder

postalCode
postalCode string

Select a contacts folder

street
street string

Select a contacts folder

city
city string

Select a contacts folder

state
state string

Select a contacts folder

countryOrRegion
countryOrRegion string

Select a contacts folder

postalCode
postalCode string

Select a contacts folder

street
street string

Select a contacts folder

city
city string

Select a contacts folder

state
state string

Select a contacts folder

countryOrRegion
countryOrRegion string

Select a contacts folder

postalCode
postalCode string

Select a contacts folder

Yomi company name
yomiCompanyName string

The phonetic Japanese company name of the contact

Yomi given name
yomiGivenName string

The phonetic Japanese given name (first name) of the contact

Yomi surname
yomiSurname string

The phonetic Japanese surname (last name) of the contact

Categories
Categories string

Select a contacts folder

Change key
changeKey string

Identifies the version of the event object

Created time
createdDateTime date-time

The time the contact was created

Last modified time
lastModifiedDateTime date-time

The time the contact was modified

Returns

Contact response

Update event (V1) [DEPRECATED]

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

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Id
id True string

Select an event

Id
Id string

The Event's unique identifier

Response
Response string

Select a calendar

Time
Time date-time

Select a calendar

Type
Type string

Select a calendar

Name
Name string

Select a calendar

Address
Address email

Select a calendar

ContentType
ContentType string

Select a calendar

Content
Content string

Select a calendar

Body preview
BodyPreview string

The preview of the message associated with the event

Categories
Categories string

Select a calendar

Change key
ChangeKey string

This property identifies the version of the event object. Every time the event is changed, ChangeKey changes as well.

Created time
DateTimeCreated date-time

The date and time that the event was created

Last modified time
DateTimeLastModified date-time

The date and time that the event was last modified

End time
End True date-time

The end time of the event

End time zone
EndTimeZone 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?
HasAttachments boolean

Set to true if the event has attachments

Importance
Importance string

The importance of the event: Low, Normal, or High

Is all day event?
IsAllDay boolean

Set to true if the event lasts all day

Is cancelled?
IsCancelled boolean

Set to true if the event has been canceled

Is Organizer
IsOrganizer boolean

Set to true if the message sender is also the organizer

DisplayName
DisplayName string

Select a calendar

Street
Street string

Select a calendar

City
City string

Select a calendar

State
State string

Select a calendar

CountryOrRegion
CountryOrRegion string

Select a calendar

PostalCode
PostalCode string

Select a calendar

Altitude
Altitude double

Select a calendar

Latitude
Latitude double

Select a calendar

Longitude
Longitude double

Select a calendar

Accuracy
Accuracy double

Select a calendar

AltitudeAccuracy
AltitudeAccuracy double

Select a calendar

Name
Name string

Select a calendar

Address
Address email

Select a calendar

Type
Type string

Select a calendar

Interval
Interval integer

Select a calendar

Month
Month integer

Select a calendar

DayOfMonth
DayOfMonth integer

Select a calendar

DaysOfWeek
DaysOfWeek string

Select a calendar

FirstDayOfWeek
FirstDayOfWeek string

Select a calendar

Index
Index string

Select a calendar

Type
Type string

Select a calendar

StartDate
StartDate date-time

Select a calendar

EndDate
EndDate date-time

Select a calendar

NumberOfOccurrences
NumberOfOccurrences integer

Select a calendar

Reminder
Reminder integer

Time in minutes before event start to remind

Response requested
ResponseRequested boolean

Set to true if the sender would like a response when the event is accepted or declined

Response
Response string

Select a calendar

Time
Time date-time

Select a calendar

Series master id
SeriesMasterId string

Unique identifier for Series Master event type

Show as
ShowAs string

Shows as free or busy

Start time
Start True date-time

The start time of the event

Start time zone
StartTimeZone 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
Subject True string

Event subject

Type
Type string

The event type: Single Instance, Occurrence, Exception, or Series Master

Web link
WebLink uri

The preview of the message associated with the event

Reason
Reason string

The reason property used by O365 sync events protocol, will be 'deleted' if its a deleted event.

Returns

Connector specific calendar event model class for the backend

Update event (V2) [DEPRECATED]

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

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Id
id True string

Select an event

Subject
Subject True string

Event subject

Start time
Start True date-time

Start time of the event (example: '2016-11-01T14:30:00Z')

End time
End True date-time

End time of the event (example: '2016-11-01T15:30:00Z')

Time zone
TimeZone string

Time zone of the event

Required attendees
RequiredAttendees email

Required attendees for the event separated by semicolons

Optional attendees
OptionalAttendees email

Optional attendees for the event separated by semicolons

Resource attendees
ResourceAttendees string

Resource attendees for the event separated by semicolons

Body
Body string

Body of the message associated with the event

Is HTML
IsHtml boolean

Set to true if the body is Html

Location
Location string

Location of the event

Importance
Importance string

The importance of the event: Low, Normal, or High

Is all day event?
IsAllDay boolean

Set to true if the event lasts all day

Recurrence
Recurrence string

The recurrence pattern for the event

Recurrence end time
RecurrenceEnd date-time

End time of the recurrence

Number of occurrences
NumberOfOccurrences integer

How many times to repeat the event

Reminder
Reminder integer

Time in minutes before event start to remind

Show as
ShowAs string

Status to show during the event

Response requested
ResponseRequested boolean

Set to true if the sender would like a response when the event is accepted or declined

Returns

Connector specific calendar event model class for the client

Update event (V3)

This operation updates an event in a calendar.

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Id
id True string

Select an event

Subject
Subject True string

Event subject

Start time
Start True date-time

Start time of the event (example: '2016-11-01T14:30:00Z')

End time
End True date-time

End time of the event (example: '2016-11-01T15:30:00Z')

Time zone
TimeZone string

Time zone of the event

Required attendees
RequiredAttendees email

Required attendees for the event separated by semicolons

Optional attendees
OptionalAttendees email

Optional attendees for the event separated by semicolons

Resource attendees
ResourceAttendees string

Resource attendees for the event separated by semicolons

Body
Body html

Body of the message associated with the event

Location
Location string

Location of the event

Importance
Importance string

The importance of the event: Low, Normal, or High

Is all day event?
IsAllDay boolean

Set to true if the event lasts all day

Recurrence
Recurrence string

The recurrence pattern for the event

Recurrence end time
RecurrenceEnd date-time

End time of the recurrence

Number of occurrences
NumberOfOccurrences integer

How many times to repeat the event

Reminder
Reminder integer

Time in minutes before event start to remind

Show as
ShowAs string

Status to show during the event

Response requested
ResponseRequested boolean

Set to true if the sender would like a response when the event is accepted or declined

Returns

Connector specific calendar event model class for the client

Update event (V4)

This operation updates an event in a calendar using Graph API.

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Id
id True string

Select an event

Subject
subject True string

Event subject

Start time
start True date-no-tz

Start time of the event (example: '2017-08-29T04:00:00')

End time
end True date-no-tz

End time of the event (example: '2017-08-29T05:00:00')

Time zone
timeZone True string

Time zone of the event

Required attendees
requiredAttendees email

Required attendees for the event separated by semicolons

Optional attendees
optionalAttendees email

Optional attendees for the event separated by semicolons

Resource attendees
resourceAttendees string

Resource attendees for the event separated by semicolons

Body
body html

Body of the message associated with the event

Location
location string

Location of the event

Importance
importance string

The importance of the event: low, normal, or high

Is all day event?
isAllDay boolean

Set to true if the event lasts all day

Recurrence
recurrence string

The recurrence pattern for the event: none, daily, weekly, monthly or yearly

Recurrence end date
recurrenceEnd date

End date of the recurrence

Number of occurrences
numberOfOccurences integer

How many times to repeat the event

Reminder
reminderMinutesBeforeStart integer

Time in minutes before event start to remind

Show as
showAs string

Status to show during the event: free, tentative, busy, oof, workingElsewhere or unknown

Response requested
responseRequested boolean

Set to true if the sender would like a response when the event is accepted or declined

Returns

Connector specific calendar event model class for the client with Graph API

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.

When a new email arrives (V2)

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.

When a new email arrives (webhook) [DEPRECATED]

This operation triggers a flow when a new email arrives.

When a new email arrives in a shared mailbox

This operation triggers a flow when a new email arrives in a shared mailbox. Your account should have permission to access the mailbox for this operation to succeed. 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.

When a new email arrives in a shared mailbox (V2)

This operation triggers a flow when a new email arrives in a shared mailbox. Your account should have permission to access the mailbox for this operation to succeed. 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.

When a new email mentioning me arrives (V2)

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.

When a new email mentioning me arrives [DEPRECATED]

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.

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

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

When a new event is created (V2)

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

When a new event is created (V3)

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

When an email is flagged (V2)

This operation triggers a flow when an email is flagged.

When an email is flagged [DEPRECATED]

This operation triggers a flow when an email is flagged.

When an event is added, updated or deleted

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

When an event is added, updated or deleted (V2)

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

When an event is modified (V1) [DEPRECATED]

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

When an event is modified (V2)

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

When an event is modified (V3)

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

When an upcoming event is starting soon (V2)

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

When an upcoming event is starting soon (V3)

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

When an upcoming event is starting soon [DEPRECATED]

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

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.

Parameters

Name Key Required Type Description
Folder
folderPath string

Mail folder to check for new emails.

To
to email

Recipient email addresses separated by semicolons (If any match, the trigger will run).

CC
cc email

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

To or CC
toOrCc email

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

From
from email

Sender email addresses separated by semicolons (If any match, the trigger will run).

Importance
importance string

Importance of the email (Any, High, Normal, Low).

Has Attachment
fetchOnlyWithAttachment boolean

Should the email contain attachments.

Include Attachments
includeAttachments boolean

Should the response of the trigger include the attachments.

Subject Filter
subjectFilter string

String to look for in the subject line.

Returns

Represents a wrapper object for batch trigger response

When a new email arrives (V2)

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.

Parameters

Name Key Required Type Description
Folder
folderPath string

Mail folder to check for new emails.

To
to email

Recipient email addresses separated by semicolons (If any match, the trigger will run).

CC
cc email

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

To or CC
toOrCc email

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

From
from email

Sender email addresses separated by semicolons (If any match, the trigger will run).

Importance
importance string

Importance of the email (Any, High, Normal, Low).

Has Attachment
fetchOnlyWithAttachment boolean

Should the email contain attachments.

Include Attachments
includeAttachments boolean

Should the response of the trigger include the attachments.

Subject Filter
subjectFilter string

String to look for in the subject line.

Returns

Represents a wrapper object for batch trigger response

When a new email arrives (webhook) [DEPRECATED]

This operation triggers a flow when a new email arrives.

Parameters

Name Key Required Type Description
Folder
folderPath string

Mail folder to check for new emails.

Importance
importance string

Importance of the received email ("Any", "High", "Normal", "Low").

Has Attachment
hasAttachment string

Whether the email has attachments ("Any", "Yes", "No").

Returns

Represents a wrapper object for batch trigger response

When a new email arrives in a shared mailbox

This operation triggers a flow when a new email arrives in a shared mailbox. Your account should have permission to access the mailbox for this operation to succeed. 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.

Parameters

Name Key Required Type Description
Mailbox Address
mailboxAddress True string

Address of the shared mailbox.

Folder
folderId string

Mail folder to check for new emails.

To
to email

Recipient email addresses separated by semicolons (If any match, the trigger will run).

CC
cc email

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

To or CC
toOrCc email

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

From
from email

Sender email addresses separated by semicolons (If any match, the trigger will run).

Importance
importance string

Importance of the email (Any, High, Normal, Low).

Has Attachment
hasAttachments boolean

Should the email contain attachments.

Include Attachments
includeAttachments boolean

Should the response of the trigger include the attachments.

Subject Filter
subjectFilter string

String to look for in the subject line.

Returns

Represents a wrapper object for batch trigger response

When a new email arrives in a shared mailbox (V2)

This operation triggers a flow when a new email arrives in a shared mailbox. Your account should have permission to access the mailbox for this operation to succeed. 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.

Parameters

Name Key Required Type Description
Mailbox Address
mailboxAddress True string

Address of the shared mailbox.

Folder
folderId string

Mail folder to check for new emails.

To
to email

Recipient email addresses separated by semicolons (If any match, the trigger will run).

CC
cc email

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

To or CC
toOrCc email

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

From
from email

Sender email addresses separated by semicolons (If any match, the trigger will run).

Importance
importance string

Importance of the email (Any, High, Normal, Low).

Has Attachment
hasAttachments boolean

Should the email contain attachments.

Include Attachments
includeAttachments boolean

Should the response of the trigger include the attachments.

Subject Filter
subjectFilter string

String to look for in the subject line.

Returns

Represents a wrapper object for batch trigger response

When a new email mentioning me arrives (V2)

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.

Parameters

Name Key Required Type Description
Folder
folderPath string

Mail folder to check for new emails.

To
to email

Recipient email addresses separated by semicolons (If any match, the trigger will run).

CC
cc email

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

To or CC
toOrCc email

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

From
from email

Sender email addresses separated by semicolons (If any match, the trigger will run).

Importance
importance string

Importance of the email (Any, High, Normal, Low).

Has Attachment
fetchOnlyWithAttachment boolean

Should the email contain attachments.

Include Attachments
includeAttachments boolean

Should the response of the trigger include the attachments.

Subject Filter
subjectFilter string

String to look for in the subject line.

Returns

Represents a wrapper object for batch trigger response

When a new email mentioning me arrives [DEPRECATED]

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.

Parameters

Name Key Required Type Description
Folder
folderPath string

Mail folder to check for new emails.

To
to email

Recipient email addresses separated by semicolons (If any match, the trigger will run).

CC
cc email

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

To or CC
toOrCc email

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

From
from email

Sender email addresses separated by semicolons (If any match, the trigger will run).

Importance
importance string

Importance of the email (Any, High, Normal, Low).

Has Attachment
fetchOnlyWithAttachment boolean

Should the email contain attachments.

Include Attachments
includeAttachments boolean

Should the response of the trigger include the attachments.

Subject Filter
subjectFilter string

String to look for in the subject line.

Returns

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)

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Order By
$orderby string

An ODATA orderBy query for specifying the order of entries.

Top Count
$top integer

Total number of entries to retrieve (default = all).

Skip Count
$skip integer

The number of entries to skip (default = 0).

Returns

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)

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Order By
$orderby string

An ODATA orderBy query for specifying the order of entries.

Top Count
$top integer

Total number of entries to retrieve (default = all).

Skip Count
$skip integer

The number of entries to skip (default = 0).

Returns

The list of calendar items

When a new event is created (V3)

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

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Order By
$orderby string

An ODATA orderBy query for specifying the order of entries.

Top Count
$top integer

Total number of entries to retrieve (default = all).

Skip Count
$skip integer

The number of entries to skip (default = 0).

Returns

The list of calendar items returned by Graph API

When an email is flagged (V2)

This operation triggers a flow when an email is flagged.

Parameters

Name Key Required Type Description
Folder
folderPath string

Mail folder to check for new emails.

To
to email

Recipient email addresses separated by semicolons (If any match, the trigger will run).

CC
cc email

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

To or CC
toOrCc email

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

From
from email

Sender email addresses separated by semicolons (If any match, the trigger will run).

Importance
importance string

Importance of the email (Any, High, Normal, Low).

Has Attachment
fetchOnlyWithAttachment boolean

Should the email contain attachments.

Include Attachments
includeAttachments boolean

Should the response of the trigger include the attachments.

Subject Filter
subjectFilter string

String to look for in the subject line.

Returns

Represents a wrapper object for batch trigger response

When an email is flagged [DEPRECATED]

This operation triggers a flow when an email is flagged.

Parameters

Name Key Required Type Description
Folder
folderPath string

Mail folder to check for new emails.

To
to email

Recipient email addresses separated by semicolons (If any match, the trigger will run).

CC
cc email

CC recipient email addresses separated by semicolons (If any match, the trigger will run).

To or CC
toOrCc email

To or CC recipient email addresses separated by semicolons (If any match, the trigger will run).

From
from email

Sender email addresses separated by semicolons (If any match, the trigger will run).

Importance
importance string

Importance of the email (Any, High, Normal, Low).

Has Attachment
fetchOnlyWithAttachment boolean

Should the email contain attachments.

Include Attachments
includeAttachments boolean

Should the response of the trigger include the attachments.

Subject Filter
subjectFilter string

String to look for in the subject line.

Returns

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.

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Incoming Days Tracked
incomingDays integer

Number of incoming days in calendar to be tracked

Past Days Tracked
pastDays integer

Number of past days in calendar to be tracked

Returns

The list of calendar items with action type

When an event is added, updated or deleted (V2)

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

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Incoming Days Tracked
incomingDays integer

Number of incoming days in calendar to be tracked

Past Days Tracked
pastDays integer

Number of past days in calendar to be tracked

Returns

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)

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Order By
$orderby string

An ODATA orderBy query for specifying the order of entries.

Top Count
$top integer

Total number of entries to retrieve (default = all).

Skip Count
$skip integer

The number of entries to skip (default = 0).

Returns

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)

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Order By
$orderby string

An ODATA orderBy query for specifying the order of entries.

Top Count
$top integer

Total number of entries to retrieve (default = all).

Skip Count
$skip integer

The number of entries to skip (default = 0).

Returns

The list of calendar items

When an event is modified (V3)

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

Parameters

Name Key Required Type Description
Calendar id
table True string

Select a calendar

Order By
$orderby string

An ODATA orderBy query for specifying the order of entries.

Top Count
$top integer

Total number of entries to retrieve (default = all).

Skip Count
$skip integer

The number of entries to skip (default = 0).

Returns

The list of calendar items returned by Graph API

When an upcoming event is starting soon (V2)

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

Parameters

Name Key Required Type Description
Calendar Id
table True string

Unique identifier of the calendar.

Look-Ahead Time
lookAheadTimeInMinutes integer

Time (in minutes) to look ahead for upcoming events.

Returns

The list of calendar items

When an upcoming event is starting soon (V3)

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

Parameters

Name Key Required Type Description
Calendar Id
table True string

Unique identifier of the calendar.

Look-Ahead Time
lookAheadTimeInMinutes integer

Time (in minutes) to look ahead for upcoming events.

Returns

The list of calendar items returned by Graph API

When an upcoming event is starting soon [DEPRECATED]

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

Parameters

Name Key Required Type Description
Calendar Id
table True string

Unique identifier of the calendar.

Look-Ahead Time
lookAheadTimeInMinutes integer

Time (in minutes) to look ahead for upcoming events.

Returns

The list of calendar items

Definitions

CalendarEventList

The list of calendar items

Name Path Type Description
value
value array of CalendarEventBackend

List of calendar items

CalendarEventBackend

Connector specific calendar event model class for the backend

Name Path Type Description
Id
Id string

The Event's unique identifier

Attendees
Attendees array of Attendee

List of attendees for the event

Body
Body ItemBody
Body preview
BodyPreview string

The preview of the message associated with the event

Categories
Categories array of string

The categories associated with the event

Change key
ChangeKey string

This property identifies the version of the event object. Every time the event is changed, ChangeKey changes as well.

Created time
DateTimeCreated date-time

The date and time that the event was created

Last modified time
DateTimeLastModified date-time

The date and time that the event was last modified

End time
End date-time

The end time of the event

End time zone
EndTimeZone 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?
HasAttachments boolean

Set to true if the event has attachments

Importance
Importance string

The importance of the event: Low, Normal, or High

Is all day event?
IsAllDay boolean

Set to true if the event lasts all day

Is cancelled?
IsCancelled boolean

Set to true if the event has been canceled

Is Organizer
IsOrganizer boolean

Set to true if the message sender is also the organizer

Location
Location Location
Organizer
Organizer Recipient
Recurrence
Recurrence PatternedRecurrence
Reminder
Reminder integer

Time in minutes before event start to remind

Response requested
ResponseRequested boolean

Set to true if the sender would like a response when the event is accepted or declined

ResponseStatus
ResponseStatus ResponseStatus
Series master id
SeriesMasterId string

Unique identifier for Series Master event type

Show as
ShowAs string

Shows as free or busy

Start time
Start date-time

The start time of the event

Start time zone
StartTimeZone 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
Subject string

Event subject

Type
Type string

The event type: Single Instance, Occurrence, Exception, or Series Master

Web link
WebLink uri

The preview of the message associated with the event

Reason
Reason string

The reason property used by O365 sync events protocol, will be 'deleted' if its a deleted event.

Attendee

Name Path Type Description
Status
Status ResponseStatus
Type
Type string
EmailAddress
EmailAddress EmailAddress

ItemBody

Name Path Type Description
ContentType
ContentType string
Content
Content string

Location

Name Path Type Description
DisplayName
DisplayName string
Address
Address PhysicalAddress
Coordinates
Coordinates GeoCoordinates

Recipient

Name Path Type Description
EmailAddress
EmailAddress EmailAddress

PatternedRecurrence

Name Path Type Description
Pattern
Pattern RecurrencePattern
Range
Range RecurrenceRange

ResponseStatus

Name Path Type Description
Response
Response string
Time
Time date-time

EmailAddress

Name Path Type Description
Name
Name string
Address
Address email

PhysicalAddress

Name Path Type Description
Street
Street string
City
City string
State
State string
CountryOrRegion
CountryOrRegion string
PostalCode
PostalCode string

GeoCoordinates

Name Path Type Description
Altitude
Altitude double
Latitude
Latitude double
Longitude
Longitude double
Accuracy
Accuracy double
AltitudeAccuracy
AltitudeAccuracy double

RecurrencePattern

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

RecurrenceRange

Name Path Type Description
Type
Type string
StartDate
StartDate date-time
EndDate
EndDate date-time
NumberOfOccurrences
NumberOfOccurrences integer

CalendarEventListClientReceive

The list of calendar items

Name Path Type Description
value
value array of CalendarEventClientReceive

List of calendar items

CalendarEventClientReceive

Connector specific calendar event model class for the client

Name Path Type Description
Subject
Subject string

Event subject

Start time
Start date-time

Start time of the event (example: '2016-11-01T14:30:00Z')

End time
End date-time

End time of the event (example: '2016-11-01T15:30:00Z')

Show as
ShowAs integer

Status to show during the event (Unknown - -1, Free - 0, Tentative - 1, Busy - 2, Oof - 3, WorkingElsewhere - 4)

Recurrence
Recurrence integer

The recurrence pattern for the event (None - 0, Daily - 1, Weekly - 2, Monthly - 3, Yearly - 4)

Response type
ResponseType integer

The response type of the event (None - 0, Organizer - 1, TentativelyAccepted - 2, Accepted - 3, Declined - 4, NotResponded - 5)

Response time
ResponseTime date-time

The response time of the event

Importance
Importance integer

The importance of the event (0 – Low, 1 – Normal, 2 - High)

Id
Id string

The event's unique identifier

Created time
DateTimeCreated date-time

The date and time that the event was created

Last modified time
DateTimeLastModified date-time

The date and time that the event was last modified

Organizer
Organizer email

The organizer of the event

Time zone
TimeZone string

Time zone of the event

Series master id
SeriesMasterId string

Unique identifier for Series Master event type

Categories
Categories array of string

The categories associated with the event

Required attendees
RequiredAttendees email

Required attendees for the event separated by semicolons

Optional attendees
OptionalAttendees email

Optional attendees for the event separated by semicolons

Resource attendees
ResourceAttendees string

Resource attendees for the event separated by semicolons

Body
Body string

Body of the message associated with the event

Is HTML
IsHtml boolean

Set to true if the body is Html

Location
Location string

Location of the event

Is all day event?
IsAllDay boolean

Set to true if the event lasts all day

Recurrence end time
RecurrenceEnd date-time

End time of the recurrence

Number of occurrences
NumberOfOccurrences integer

How many times to repeat the event

Reminder
Reminder integer

Time in minutes before event start to remind

Response requested
ResponseRequested boolean

Set to true if the sender would like a response when the event is accepted or declined

PaginatedListResponse[CalendarEventClientReceiveStringEnums]

Response containing a list and next link

Name Path Type Description
Values
Values array of CalendarEventClientReceiveStringEnums

Values

CalendarEventClientReceiveStringEnums

Connector specific calendar event model class for the client

Name Path Type Description
Importance
Importance string

The importance of the event: Low, Normal, or High

Response type
ResponseType string

The response type of the event: None, Organizer, TentativelyAccepted, Accepted, Declined or NotResponded

Recurrence
Recurrence string

The recurrence pattern for the event

Show as
ShowAs string

Status to show during the event

Subject
Subject string

Event subject

Start time
Start date-time

Start time of the event (example: '2016-11-01T14:30:00Z')

End time
End date-time

End time of the event (example: '2016-11-01T15:30:00Z')

Response time
ResponseTime date-time

The response time of the event

Id
Id string

The event's unique identifier

Created time
DateTimeCreated date-time

The date and time that the event was created

Last modified time
DateTimeLastModified date-time

The date and time that the event was last modified

Organizer
Organizer email

The organizer of the event

Time zone
TimeZone string

Time zone of the event

Series master id
SeriesMasterId string

Unique identifier for Series Master event type

Categories
Categories array of string

The categories associated with the event

Required attendees
RequiredAttendees email

Required attendees for the event separated by semicolons

Optional attendees
OptionalAttendees email

Optional attendees for the event separated by semicolons

Resource attendees
ResourceAttendees string

Resource attendees for the event separated by semicolons

Body
Body string

Body of the message associated with the event

Is HTML
IsHtml boolean

Set to true if the body is Html

Location
Location string

Location of the event

Is all day event?
IsAllDay boolean

Set to true if the event lasts all day

Recurrence end time
RecurrenceEnd date-time

End time of the recurrence

Number of occurrences
NumberOfOccurrences integer

How many times to repeat the event

Reminder
Reminder integer

Time in minutes before event start to remind

Response requested
ResponseRequested boolean

Set to true if the sender would like a response when the event is accepted or declined

ClientReceiveMessageStringEnums

Receive Email Message

Name Path Type Description
Importance
Importance string

The importance of the message

From
From email

The mailbox owner and sender of the message

To
To email

The recipients for the message

CC
Cc email

The Cc recipients for the message

BCC
Bcc email

The Bcc recipients for the message

Subject
Subject string

The subject of the message

Body
Body string

The body of the message

Body Preview
BodyPreview string

The preview of the message

Has Attachment
HasAttachment boolean

Indicates whether the message has attachments

Message Id
Id string

The unique identifier of the message

Internet Message Id
InternetMessageId string

The message ID in the format specified by RFC2822

Conversation Id
ConversationId string

The Id of the conversation the email belongs to

Received Time
DateTimeReceived date-time

The date and time the message was received

Is Read
IsRead boolean

Indicates whether the message has been read

Attachments
Attachments array of ClientReceiveFileAttachment

The file attachments for the message

Is HTML
IsHtml boolean

Is Html?

ClientReceiveFileAttachment

File Attachment

Name Path Type Description
Attachment Id
Id string

Attachment Id

Name
Name string

Attachment name

Content
ContentBytes byte

Attachment content

Content-Type
ContentType string

Attachment content type

BatchResponse[ClientReceiveMessage]

Represents a wrapper object for batch response

Name Path Type Description
value
value array of ClientReceiveMessage

A list of the response objects

ClientReceiveMessage

Receive Email Message

Name Path Type Description
From
From email

The mailbox owner and sender of the message

To
To email

The recipients for the message

CC
Cc email

The Cc recipients for the message

BCC
Bcc email

The Bcc recipients for the message

Subject
Subject string

The subject of the message

Body
Body string

The body of the message

Importance
Importance integer

The importance of the message (0 – Low, 1 – Normal, 2 - High)

Body Preview
BodyPreview string

The preview of the message

Has Attachment
HasAttachment boolean

Indicates whether the message has attachments

Message Id
Id string

The unique identifier of the message

Internet Message Id
InternetMessageId string

The message ID in the format specified by RFC2822

Conversation Id
ConversationId string

The Id of the conversation the email belongs to

Received Time
DateTimeReceived date-time

The date and time the message was received

Is Read
IsRead boolean

Indicates whether the message has been read

Attachments
Attachments array of ClientReceiveFileAttachment

The file attachments for the message

Is HTML
IsHtml boolean

Is Html?

GraphClientReceiveMessage

Graph Client Receive Email Message

Name Path Type Description
From
from email

The mailbox owner and sender of the message

To
toRecipients email

The recipients for the message

CC
ccRecipients email

The Cc recipients for the message

BCC
bccRecipients email

The Bcc recipients for the message

Subject
subject string

The subject of the message

Body
body string

The body of the message

Importance
importance string

The importance of the message (low, normal, high)

Body Preview
bodyPreview string

The preview of the message

Has Attachment
hasAttachments boolean

Indicates whether the message has attachments

Message Id
id string

The unique identifier of the message

Internet Message Id
internetMessageId string

The message ID in the format specified by RFC2822

Conversation Id
conversationId string

The Id of the conversation the email belongs to

Received Time
receivedDateTime date-time

The date and time the message was received

Is Read
isRead boolean

Indicates whether the message has been read

Attachments
attachments array of GraphClientReceiveFileAttachment

The file attachments for the message

Is HTML
isHtml boolean

Is Html?

GraphClientReceiveFileAttachment

File Attachment

Name Path Type Description
Attachment Id
id string

Attachment Id

Name
name string

Attachment name

Content
contentBytes byte

Attachment content

Content-Type
contentType string

Attachment content type

BatchResponse[GraphClientReceiveMessage]

Represents a wrapper object for batch response

Name Path Type Description
value
value array of GraphClientReceiveMessage

A list of the response objects

TriggerBatchResponse[ClientReceiveMessage]

Represents a wrapper object for batch trigger response

Name Path Type Description
value
value array of ClientReceiveMessage

A list of the response objects

TriggerBatchResponse[GraphClientReceiveMessage]

Represents a wrapper object for batch trigger response

Name Path Type Description
value
value array of GraphClientReceiveMessage

A list of the response objects

MailTipsClientReceive

Mail tips client model returned to the caller

Name Path Type Description
AutomaticReplies
AutomaticReplies MailTipsAutomaticReplies

Automatic replies as part of mail tips

DeliveryRestricted
DeliveryRestricted boolean

Is delivery restricted

ExternalMemberCount
ExternalMemberCount integer

Number of external members

IsModerated
IsModerated boolean

Is moderated

MailboxFull
MailboxFull boolean

Is mailbox full

MaxMessageSize
MaxMessageSize integer

Maximum message size

TotalMemberCount
TotalMemberCount integer

Total member count

MailTipsAutomaticReplies

Automatic replies as part of mail tips

Name Path Type Description
Message
Message string

Automatic replies message

ApprovalEmailResponse

Approval Email Response

Name Path Type Description
SelectedOption
SelectedOption string

User response

TriggerBatchResponse[ReceiveMessageMetadata]

Represents a wrapper object for batch trigger response

Name Path Type Description
value
value array of ReceiveMessageMetadata

A list of the response objects

ReceiveMessageMetadata

Receive Email Message

Name Path Type Description
From
From email

The mailbox owner and sender of the message

To
To email

The recipients for the message

CC
Cc email

The Cc recipients for the message

BCC
Bcc email

The Bcc recipients for the message

Subject
Subject string

The subject of the message

Importance
Importance integer

The importance of the message (0 – Low, 1 – Normal, 2 - High)

Has Attachment
HasAttachment boolean

Indicates whether the message has attachments

Message Id
Id string

The unique identifier of the message

Received Time
DateTimeReceived date-time

The date and time the message was received

Is Read
IsRead boolean

Indicates whether the message has been read

EntityListResponse[Table]

Entity list response

Name Path Type Description
value
value array of Table

List of values

Table

Represents a table.

Name Path Type Description
Name
Name string

The name of the table. The name is used at runtime.

DisplayName
DisplayName string

The display name of the table.

DynamicProperties
DynamicProperties object

Additional table properties provided by the connector to the clients.

EntityListResponse[CalendarEventBackend]

Entity list response

Name Path Type Description
value
value array of CalendarEventBackend

List of values

GraphCalendarEventListClientReceive

The list of calendar items returned by Graph API

Name Path Type Description
value
value array of GraphCalendarEventClientReceive

List of calendar items

GraphCalendarEventClientReceive

Connector specific calendar event model class for the client with Graph API

Name Path Type Description
Subject
subject string

Event subject

Start time
start date-no-tz

Start time of the event (example: '2017-08-29T04:00:00.0000000')

End time
end date-no-tz

End time of the event (example: '2017-08-29T05:00:00.0000000')

Body
body html

Body of the message associated with the event

Is HTML
isHtml boolean

Set to true if the body is Html

Response type
responseType string

The response type of the event (none, organizer, tentativelyAccepted, accepted, declined or notResponded)

Response time
responseTime date-time

The response time of the event

Id
id string

The event's unique identifier

Created time
createdDateTime date-time

The date and time that the event was created

Last modified time
lastModifiedDateTime date-time

The date and time that the event was last modified

Organizer
organizer email

The organizer of the event

Time zone
timeZone string

Time zone of the event

Series master id
seriesMasterId string

Unique identifier for Series Master event type

Categories
categories array of string

The categories associated with the event

Required attendees
requiredAttendees email

Required attendees for the event separated by semicolons

Optional attendees
optionalAttendees email

Optional attendees for the event separated by semicolons

Resource attendees
resourceAttendees string

Resource attendees for the event separated by semicolons

Location
location string

Location of the event

Importance
importance string

The importance of the event: low, normal, or high

Is all day event?
isAllDay boolean

Set to true if the event lasts all day

Recurrence
recurrence string

The recurrence pattern for the event: none, daily, weekly, monthly or yearly

Recurrence end time
recurrenceEnd date

End time of the recurrence

Number of occurrences
numberOfOccurences integer

How many times to repeat the event

Reminder
reminderMinutesBeforeStart integer

Time in minutes before event start to remind

Show as
showAs string

Status to show during the event: free, tentative, busy, oof, workingElsewhere or unknown

Response requested
responseRequested boolean

Set to true if the sender would like a response when the event is accepted or declined

EntityListResponse[CalendarEventClientReceiveStringEnums]

Entity list response

Name Path Type Description
value
value array of CalendarEventClientReceiveStringEnums

List of values

EntityListResponse[GraphCalendarEventClientReceive]

Entity list response

Name Path Type Description
value
value array of GraphCalendarEventClientReceive

List of values

CalendarEventListWithActionType

The list of calendar items with action type

Name Path Type Description
value
value array of CalendarEventClientWithActionType

List of calendar items

CalendarEventClientWithActionType

Calendar event model with action type

Name Path Type Description
Action Type
ActionType string

Changed action type of the event - added, updated or deleted.

Subject
Subject string

Event subject

Start time
Start date-time

Start time of the event (example: '2016-11-01T14:30:00Z')

End time
End date-time

End time of the event (example: '2016-11-01T15:30:00Z')

Show as
ShowAs integer

Status to show during the event (Unknown - -1, Free - 0, Tentative - 1, Busy - 2, Oof - 3, WorkingElsewhere - 4)

Recurrence
Recurrence integer

The recurrence pattern for the event (None - 0, Daily - 1, Weekly - 2, Monthly - 3, Yearly - 4)

Response type
ResponseType integer

The response type of the event (None - 0, Organizer - 1, TentativelyAccepted - 2, Accepted - 3, Declined - 4, NotResponded - 5)

Response time
ResponseTime date-time

The response time of the event

Importance
Importance integer

The importance of the event (0 – Low, 1 – Normal, 2 - High)

Id
Id string

The event's unique identifier

Created time
DateTimeCreated date-time

The date and time that the event was created

Last modified time
DateTimeLastModified date-time

The date and time that the event was last modified

Organizer
Organizer email

The organizer of the event

Time zone
TimeZone string

Time zone of the event

Series master id
SeriesMasterId string

Unique identifier for Series Master event type

Categories
Categories array of string

The categories associated with the event

Required attendees
RequiredAttendees email

Required attendees for the event separated by semicolons

Optional attendees
OptionalAttendees email

Optional attendees for the event separated by semicolons

Resource attendees
ResourceAttendees string

Resource attendees for the event separated by semicolons

Body
Body string

Body of the message associated with the event

Is HTML
IsHtml boolean

Set to true if the body is Html

Location
Location string

Location of the event

Is all day event?
IsAllDay boolean

Set to true if the event lasts all day

Recurrence end time
RecurrenceEnd date-time

End time of the recurrence

Number of occurrences
NumberOfOccurrences integer

How many times to repeat the event

Reminder
Reminder integer

Time in minutes before event start to remind

Response requested
ResponseRequested boolean

Set to true if the sender would like a response when the event is accepted or declined

GraphCalendarEventListWithActionType

The list of calendar items with action type

Name Path Type Description
value
value array of GraphCalendarEventClientWithActionType

List of calendar items

GraphCalendarEventClientWithActionType

Graph calendar event model with action type

Name Path Type Description
Action Type
ActionType string

Changed action type of the event - added, updated or deleted.

Subject
subject string

Event subject

Start time
start date-no-tz

Start time of the event (example: '2017-08-29T04:00:00.0000000')

End time
end date-no-tz

End time of the event (example: '2017-08-29T05:00:00.0000000')

Body
body html

Body of the message associated with the event

Is HTML
isHtml boolean

Set to true if the body is Html

Response type
responseType string

The response type of the event (none, organizer, tentativelyAccepted, accepted, declined or notResponded)

Response time
responseTime date-time

The response time of the event

Id
id string

The event's unique identifier

Created time
createdDateTime date-time

The date and time that the event was created

Last modified time
lastModifiedDateTime date-time

The date and time that the event was last modified

Organizer
organizer email

The organizer of the event

Time zone
timeZone string

Time zone of the event

Series master id
seriesMasterId string

Unique identifier for Series Master event type

Categories
categories array of string

The categories associated with the event

Required attendees
requiredAttendees email

Required attendees for the event separated by semicolons

Optional attendees
optionalAttendees email

Optional attendees for the event separated by semicolons

Resource attendees
resourceAttendees string

Resource attendees for the event separated by semicolons

Location
location string

Location of the event

Importance
importance string

The importance of the event: low, normal, or high

Is all day event?
isAllDay boolean

Set to true if the event lasts all day

Recurrence
recurrence string

The recurrence pattern for the event: none, daily, weekly, monthly or yearly

Recurrence end date
recurrenceEnd date

End Date of the recurrence

Number of occurrences
numberOfOccurences integer

How many times to repeat the event

Reminder
reminderMinutesBeforeStart integer

Time in minutes before event start to remind

Show as
showAs string

Status to show during the event: free, tentative, busy, oof, workingElsewhere or unknown

Response requested
responseRequested boolean

Set to true if the sender would like a response when the event is accepted or declined

EntityListResponse[GraphContactFolder]

Entity list response

Name Path Type Description
value
value array of GraphContactFolder

List of values

GraphContactFolder

Contact folder data model returned by Graph API

Name Path Type Description
ID
id string

The ID of the contacts folder

Display Name
displayName string

The name of the contacts folder

Parent Folder ID
parentFolderId string

The ID of the parent folder

EntityListResponse[ContactResponse]

Entity list response

Name Path Type Description
value
value array of ContactResponse

List of values

ContactResponse

Contact response

Name Path Type Description
Given name
GivenName string

The contact's given name

Home phones
HomePhones array of string

The contact's home phone numbers

Id
Id string

The contact's unique identifier.

Parent folder id
ParentFolderId string

The ID of the contact's parent folder

Birthday
Birthday date-time

The contact's birthday

File as
FileAs string

The name the contact is filed under

Display Name
DisplayName string

The contact's display name

Initials
Initials string

The contact's initials

Middle name
MiddleName string

The contact's middle name

Nickname
NickName string

The contact's nickname

Surname
Surname string

The contact's surname

Title
Title string

The contact's title

Generation
Generation string

The contact's generation

Email addresses
EmailAddresses array of EmailAddress

The contact's email addresses

IM addresses
ImAddresses array of string

The contact's instant messaging (IM) addresses

JobTitle
JobTitle string

The contact's job title

Company name
CompanyName string

The name of the contact's company

Department
Department string

The contact's department

Office location
OfficeLocation string

The location of the contact's office

Profession
Profession string

The contact's profession

Business home page
BusinessHomePage string

The business home page of the contact

Assistant name
AssistantName string

The name of the contact's assistant

Manager
Manager string

The name of the contact's manager

Business phones
BusinessPhones array of string

The contact's business phone numbers

Mobile phone
MobilePhone1 string

The contact's mobile phone number

HomeAddress
HomeAddress PhysicalAddress
BusinessAddress
BusinessAddress PhysicalAddress
OtherAddress
OtherAddress PhysicalAddress
Yomi company name
YomiCompanyName string

The phonetic Japanese company name of the contact

Yomi given name
YomiGivenName string

The phonetic Japanese given name (first name) of the contact

Yomi surname
YomiSurname string

The phonetic Japanese surname (last name) of the contact

Categories
Categories array of string

The categories associated with the contact

Change key
ChangeKey string

Identifies the version of the event object

Created time
DateTimeCreated date-time

The time the contact was created

Last modified time
DateTimeLastModified date-time

The time the contact was modified

AutomaticRepliesSettingClient_V2

Automatic replies setting model for the connector

Name Path Type Description
Status
status string

Automatic reply setting status

External Audience
externalAudience string

The audience that will see the external reply message

DateTime
scheduledStartDateTime.dateTime string

Scheduled start time (example: '2017-08-29T04:00:00.0000000')

TimeZone
scheduledStartDateTime.timeZone string

TimeZone (example: 'Pacific Standard Time')

DateTime
scheduledEndDateTime.dateTime string

Scheduled end time (example: '2017-08-29T05:00:00.0000000')

TimeZone
scheduledEndDateTime.timeZone string

TimeZone (example: 'Pacific Standard Time')

Internal Reply Message
internalReplyMessage string

Message for people within your organization

External Reply Message
externalReplyMessage string

Message for people outside your organization

MailTipsClientReceive_V2

Mail tips client model returned to the caller

Name Path Type Description
automaticReplies
automaticReplies MailTipsAutomaticReplies_V2

Automatic replies as part of mail tips

Is delivery restricted
deliveryRestricted boolean

Is delivery restricted

Is moderated
externalMemberCount integer

Number of external members

Is moderated
isModerated boolean

Is moderated

Is mailbox full
mailboxFull boolean

Is mailbox full

Maximum message size
maxMessageSize integer

Maximum message size

Total member count
totalMemberCount integer

Total member count

MailTipsAutomaticReplies_V2

Automatic replies as part of mail tips

Name Path Type Description
Automatic replies message
message string

Automatic replies message

MeetingTimeSuggestions

Meeting Time Suggestions

Name Path Type Description
Confidence
Confidence float

Confidence

Organizer Availability
OrganizerAvailability string

Organizer Availability

Suggestion Reason
SuggestionReason string

Suggestion Reason

DateTimeTimeZone
MeetingTimeSlot.Start DateTimeTimeZone

DateTimeTimeZone

DateTimeTimeZone
MeetingTimeSlot.End DateTimeTimeZone

DateTimeTimeZone

Attendee Availability
AttendeeAvailability array of object

Attendee Availability

Availability
AttendeeAvailability.Availability string

Availability

Type
AttendeeAvailability.Attendee.Type string

Type

Address
AttendeeAvailability.Attendee.EmailAddress.Address string

Address

Locations
Locations array of object

Locations

Display Name
Locations.DisplayName string

Display Name

Location Email Address
Locations.LocationEmailAddress string

Location Email Address

Type
Locations.Address.Type string

Type

Street
Locations.Address.Street string

Street

City
Locations.Address.City string

City

State
Locations.Address.State string

State

Country Or Region
Locations.Address.CountryOrRegion string

Country Or Region

Postal Code
Locations.Address.PostalCode string

Postal Code

MeetingTimeSuggestions_V2

Meeting Time Suggestions

Name Path Type Description
Confidence
confidence float

Confidence

Organizer Availability
organizerAvailability string

Organizer Availability

Suggestion Reason
suggestionReason string

Suggestion Reason

DateTimeTimeZone
meetingTimeSlot.start DateTimeTimeZone_V2

DateTimeTimeZone

DateTimeTimeZone
meetingTimeSlot.end DateTimeTimeZone_V2

DateTimeTimeZone

Attendee Availability
attendeeAvailability array of object

Attendee Availability

Availability
attendeeAvailability.availability string

Availability

Type
attendeeAvailability.attendee.type string

Type

Address
attendeeAvailability.attendee.emailAddress.address string

Address

Locations
locations array of object

Locations

Display Name
locations.displayName string

Display Name

Location Email Address
locations.locationEmailAddress string

Location Email Address

Street
locations.address.street string

Street

City
locations.address.city string

City

State
locations.address.state string

State

Country Or Region
locations.address.countryOrRegion string

Country Or Region

Postal Code
locations.address.postalCode string

Postal Code

DateTimeTimeZone

DateTimeTimeZone

Name Path Type Description
DateTime
DateTime string

DateTime

TimeZone
TimeZone string

TimeZone

DateTimeTimeZone_V2

DateTimeTimeZone

Name Path Type Description
DateTime
dateTime string

DateTime (exapmle: '2017-08-29T04:00:00.0000000')

TimeZone
timeZone string

TimeZone (example: 'Pacific Standard Time')

EntityListResponse[ContactResponse]_V2

Entity list response

Name Path Type Description
value
value array of ContactResponse_V2

List of values

ContactResponse_V2

Contact response

Name Path Type Description
Given name
givenName string

The contact's given name

Home phones
homePhones array of string

The contact's home phone numbers

Id
id string

The contact's unique identifier.

Parent folder id
parentFolderId string

The ID of the contact's parent folder

Birthday
birthday date-time

The contact's birthday

File as
fileAs string

The name the contact is filed under

Display Name
displayName string

The contact's display name

Initials
initials string

The contact's initials

Middle name
middleName string

The contact's middle name

Nickname
nickName string

The contact's nickname

Surname
surname string

The contact's surname

Title
title string

The contact's title

Generation
generation string

The contact's generation

Email addresses
emailAddresses array of EmailAddress

The contact's email addresses

IM addresses
imAddresses array of string

The contact's instant messaging (IM) addresses

JobTitle
jobTitle string

The contact's job title

Company name
companyName string

The name of the contact's company

Department
department string

The contact's department

Office location
officeLocation string

The location of the contact's office

Profession
profession string

The contact's profession

Business home page
businessHomePage string

The business home page of the contact

Assistant name
assistantName string

The name of the contact's assistant

Manager
manager string

The name of the contact's manager

Business phones
businessPhones array of string

The contact's business phone numbers

Mobile phone
mobilePhone string

The contact's mobile phone number

homeAddress
homeAddress PhysicalAddress_V2
businessAddress
businessAddress PhysicalAddress_V2
otherAddress
otherAddress PhysicalAddress_V2
Yomi company name
yomiCompanyName string

The phonetic Japanese company name of the contact

Yomi given name
yomiGivenName string

The phonetic Japanese given name (first name) of the contact

Yomi surname
yomiSurname string

The phonetic Japanese surname (last name) of the contact

Categories
categories array of string

The categories associated with the contact

Change key
changeKey string

Identifies the version of the event object

Created time
createdDateTime date-time

The time the contact was created

Last modified time
lastModifiedDateTime date-time

The time the contact was modified

PhysicalAddress_V2

Name Path Type Description
street
street string
city
city string
state
state string
countryOrRegion
countryOrRegion string
postalCode
postalCode string