Outlook Tasks

Outlook Tasks service lets you create, read, synchronize, update and delete your tasks that are secured by Azure Active Directory in Office 365 or a Microsoft account.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Connector Metadata
Publisher Microsoft

Note that this integration requires permission to access resources within your AAD tenant. If you see an error trying to connect, check with your AAD admin to ensure the AAD application is approved within your tenant. More information on AAD consent can be found here.

You're now ready to start using this integration.

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds
Frequency of trigger polls115 seconds

Actions

Complete a task

This operation marks the given task as complete.

Create a task (V2)

This operation is used to create a task in the specified task folder (defaults to My Tasks).

Create a task [DEPRECATED]

This action has been deprecated. Please use Create a task (V2) instead.

This operation is used to create a task in the specified task folder (defaults to My Tasks).

Create a task folder

This operation creates a new folder. Optionally, you may choose to put the new folder in an existing task group.

Create a task group

This operation is used to create a new task group in your mailbox.

Get task

This operation is used to retrieve the details of a task by its id.

List all task groups

Returns a list of all the task groups in your mailbox.

List all tasks

This operation returns a list of all your tasks.

List all tasks in folder

This operation returns a list of all tasks in a given folder.

List task folders in group

Returns a list of task folders in the given task group.

Mark a task as incomplete

This operation is used to mark the given task as incomplete.

Complete a task

This operation marks the given task as complete.

Parameters

Name Key Required Type Description
Task
taskId True string

Unique id of the task to complete.

Returns

An Outlook task object.

Body
Task

Create a task (V2)

This operation is used to create a task in the specified task folder (defaults to My Tasks).

Parameters

Name Key Required Type Description
Folder Id
folderId string

Folder

Due Date
DateTime date-time

YYYY-MM-DD or YYYY-MM-DDThh:mm:ssZ (note the time portion will be ignored)

Reminder Date-Time
DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format)

Start Date
DateTime date-time

YYYY-MM-DD or YYYY-MM-DDThh:mm:ssZ (note the time portion will be ignored)

Importance
Importance string

Low, normal or high.

Subject
Subject True string

Brief description or title of the task.

Status
Status string

Indicates state or progress of the task - not started, in progress, completed, waiting on others or deferred.

Sensitivity
Sensitivity string

Indicates the level of privacy for the event.

Content
Content html

The content.

Category
Categories string

Associated with the task.

Is Reminder On
IsReminderOn boolean

True if an alert is set to remind the user of the task.

Returns

An Outlook task object.

Body
TaskHTML

Create a task [DEPRECATED]

This action has been deprecated. Please use Create a task (V2) instead.

This operation is used to create a task in the specified task folder (defaults to My Tasks).

Parameters

Name Key Required Type Description
Folder Id
folderId string

Folder

Due Date
DateTime date-time

YYYY-MM-DD or YYYY-MM-DDThh:mm:ssZ (note the time portion will be ignored)

Reminder Date-Time
DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format)

Start Date
DateTime date-time

YYYY-MM-DD or YYYY-MM-DDThh:mm:ssZ (note the time portion will be ignored)

Importance
Importance string

Low, normal or high.

Subject
Subject True string

Brief description or title of the task.

Status
Status string

Indicates state or progress of the task - not started, in progress, completed, waiting on others or deferred.

Sensitivity
Sensitivity string

Indicates the level of privacy for the event.

Content Type
ContentType string

Text=0, HTML=1

Content
Content string

The text or HTML content.

Category
Categories string

Associated with the task.

Is Reminder On
IsReminderOn boolean

True if an alert is set to remind the user of the task.

Returns

An Outlook task object.

Body
Task

Create a task folder

This operation creates a new folder. Optionally, you may choose to put the new folder in an existing task group.

Parameters

Name Key Required Type Description
Task group
groupId string

Group id for your task group.

Id
Id string

Unique identifier of the task folder.

Name
Name True string

Name of the task folder.

Is Default
IsDefaultFolder boolean

True if this is the default task folder.

Returns

An Outlook task folder.

Body
TaskFolder

Create a task group

This operation is used to create a new task group in your mailbox.

Parameters

Name Key Required Type Description
Id
Id string

Unique identifier of the task group.

Name
Name True string

Name of the task group.

Is Default
IsDefaultGroup boolean

True if default task group.

Returns

An Outlook task group.

Body
TaskGroup

Get task

This operation is used to retrieve the details of a task by its id.

Parameters

Name Key Required Type Description
Task Id
taskId True string

Unique id of the task.

Returns

An Outlook task object.

Body
Task

List all task groups

Returns a list of all the task groups in your mailbox.

Returns

List all tasks

This operation returns a list of all your tasks.

Returns

response
array of Task

List all tasks in folder

This operation returns a list of all tasks in a given folder.

Parameters

Name Key Required Type Description
Task group
groupId True string

Pick a task group.

Task folder
folderId True string

Pick a task folder.

Returns

response
array of Task

List task folders in group

Returns a list of task folders in the given task group.

Parameters

Name Key Required Type Description
Task group
groupId True string

Task group

Returns

Mark a task as incomplete

This operation is used to mark the given task as incomplete.

Parameters

Name Key Required Type Description
Task
taskId True string

Unique id of the task.

Status
Status string

Unique id of the task.

Completed Date-Time
DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format)

Returns

An Outlook task object.

Body
Task

Triggers

When a task is added

This operation triggers when a new task is created.

When a task is completed

This operation triggers when a task is marked as complete.

When a task is added

This operation triggers when a new task is created.

Parameters

Name Key Required Type Description
Folder
folderId string

Pick the folder to track for new tasks.

Returns

An Outlook task object.

Body
Task

When a task is completed

This operation triggers when a task is marked as complete.

Parameters

Name Key Required Type Description
Task
taskId True string

Unique id of the task to track.

Returns

An Outlook task object.

Body
Task

Definitions

TaskFolder

An Outlook task folder.

Name Path Type Description
Id
Id string

Unique identifier of the task folder.

Name
Name string

Name of the task folder.

Is Default
IsDefaultFolder boolean

True if this is the default task folder.

TaskGroup

An Outlook task group.

Name Path Type Description
Id
Id string

Unique identifier of the task group.

Name
Name string

Name of the task group.

Is Default
IsDefaultGroup boolean

True if default task group.

Task

An Outlook task object.

Name Path Type Description
Id
Id string

Unique identifier of the task.

Created Date-Time
CreatedDateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format)

Modified Date-Time
LastModifiedDateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format)

Categories
Categories array of string

Collection of category names associated with the task.

Assigned To
AssignedTo string

Name of the person who has been assigned the task.

Content Type
Body.ContentType string

Text=0, HTML=1

Content
Body.Content string

The text or HTML content.

Date-Time
CompletedDateTime.DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format)

Date
DueDateTime.DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format)

Importance
Importance string

Low, normal or high.

Is reminder on
IsReminderOn boolean

True if an alert is set to remind the user of the task.

Owner
Owner string

Name of the person who created the task.

Date-Time
ReminderDateTime.DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format)

Date
StartDateTime.DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format)

Status
Status string

Indicates state or progress of the task - not started, in progress, completed, waiting on others or deferred.

Subject
Subject string

Brief description or title of the task.

TaskHTML

An Outlook task object.

Name Path Type Description
Id
Id string

Unique identifier of the task.

Created Date-Time
CreatedDateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format)

Modified Date-Time
LastModifiedDateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format)

Categories
Categories array of string

Collection of category names associated with the task.

Assigned To
AssignedTo string

Name of the person who has been assigned the task.

Content
Body.Content html

The content.

Date-Time
CompletedDateTime.DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format)

Date
DueDateTime.DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format)

Importance
Importance string

Low, normal or high.

Is reminder on
IsReminderOn boolean

True if an alert is set to remind the user of the task.

Owner
Owner string

Name of the person who created the task.

Date-Time
ReminderDateTime.DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format)

Date
StartDateTime.DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format)

Status
Status string

Indicates state or progress of the task - not started, in progress, completed, waiting on others or deferred.

Subject
Subject string

Brief description or title of the task.