Create outlookTaskFolder (deprecated)

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Caution

The Outlook tasks API is deprecated and will stop returning data on August 20, 2022. Please use the new To Do API. For more information, see To Do APIs in public preview.

Create a task folder in the default task group (My Tasks) of the user's mailbox.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Tasks.ReadWrite
Delegated (personal Microsoft account) Tasks.ReadWrite
Application Not supported.

HTTP request

POST /me/outlook/taskFolders
POST /users/{id|userPrincipalName}/outlook/taskFolders

Request headers

Name Description
Authorization Bearer {token}. Required.

Request body

In the request body, supply a JSON representation of outlookTaskFolder object.

Response

If successful, this method returns 201 Created response code and outlookTaskFolder object in the response body.

Example

Request

The following example creates a task folder called Volunteer in the default task group (My Tasks) of the user's mailbox.

POST https://graph.microsoft.com/beta/me/outlook/taskfolders 
Content-type: application/json

{
  "name": "Volunteer"
}

In the request body, supply a JSON representation of outlookTaskFolder object.

Response

Here is an example of the response. Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-type: application/json

{
  "id": "AAMkADIyAAAhrbPWAAA=",
  "changeKey": "hmM7Eb/jgEec8l3+gkJEawAAIbAGig==",
  "isDefaultFolder": false,
  "name": "Volunteer",
  "parentGroupKey": "0006f0b7-0000-0000-c000-000000000046"
}