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 stopped returning data on August 20, 2022. Use the To Do API instead.
Update the writable properties of an Outlook task group.
You can't modify the name of the default task group, "My Tasks".
This API is available in the following national cloud deployments.
| Global service |
US Government L4 |
US Government L5 (DOD) |
China operated by 21Vianet |
| ✅ |
✅ |
✅ |
❌ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
| Permission type |
Least privileged permissions |
Higher privileged permissions |
| Delegated (work or school account) |
Tasks.ReadWrite |
Not available. |
| Delegated (personal Microsoft account) |
Tasks.ReadWrite |
Not available. |
| Application |
Not supported. |
Not supported. |
HTTP request
PATCH /me/outlook/taskGroups/{id}
PATCH /users/{id|userPrincipalName}/outlook/taskGroups/{id}
Request body
In the request body, supply the values for relevant fields that should be updated. Existing properties that aren't included in the request body maintains their previous values or are recalculated based on changes to other property values. For best performance, you shouldn't include existing values that haven't changed.
| Property |
Type |
Description |
| name |
String |
The name of the task group. |
Response
If successful, this method returns a 200 OK response code and updated outlookTaskGroup object in the response body.
Example
Request
The following example changes the name of a task group to "Personal Tasks".
PATCH https://graph.microsoft.com/beta/me/outlook/taskGroups/AAMkADIyAAAhrbe-AAA=
Content-type: application/json
{
"name": "Personal Tasks",
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new OutlookTaskGroup
{
Name = "Personal Tasks",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Outlook.TaskGroups["{outlookTaskGroup-id}"].PatchAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewOutlookTaskGroup()
name := "Personal Tasks"
requestBody.SetName(&name)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
taskGroups, err := graphClient.Me().Outlook().TaskGroups().ByOutlookTaskGroupId("outlookTaskGroup-id").Patch(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
OutlookTaskGroup outlookTaskGroup = new OutlookTaskGroup();
outlookTaskGroup.setName("Personal Tasks");
OutlookTaskGroup result = graphClient.me().outlook().taskGroups().byOutlookTaskGroupId("{outlookTaskGroup-id}").patch(outlookTaskGroup);
const options = {
authProvider,
};
const client = Client.init(options);
const outlookTaskGroup = {
name: 'Personal Tasks',
};
await client.api('/me/outlook/taskGroups/AAMkADIyAAAhrbe-AAA=')
.version('beta')
.update(outlookTaskGroup);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\OutlookTaskGroup;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new OutlookTaskGroup();
$requestBody->setName('Personal Tasks');
$result = $graphServiceClient->me()->outlook()->taskGroups()->byOutlookTaskGroupId('outlookTaskGroup-id')->patch($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Users
$params = @{
name = "Personal Tasks"
}
# A UPN can also be used as -UserId.
Update-MgBetaUserOutlookTaskGroup -UserId $userId -OutlookTaskGroupId $outlookTaskGroupId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.outlook_task_group import OutlookTaskGroup
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = OutlookTaskGroup(
name = "Personal Tasks",
)
result = await graph_client.me.outlook.task_groups.by_outlook_task_group_id('outlookTaskGroup-id').patch(request_body)
Response
The following example shows the response. Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "AAMkADIyAAAhrbe-AAA=",
"changeKey": "hmM7Eb/jgEec8l3+gkJEawAAIbAGjw==",
"isDefaultGroup": false,
"name": "Personal Tasks",
"groupKey": "63d640cf-946f-4734-9c29-60dda7b76acb"
}