Update todoTask
Namespace: microsoft.graph
Update the properties of a todoTask object.
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 | Tasks.ReadWrite.All |
HTTP request
PATCH /me/todo/lists/{todoTaskListId}/tasks/{taskId}
PATCH /users/{id|userPrincipalName}/todo/lists/{todoTaskListId}/tasks/{taskId}
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. |
Content-Type | application/json. Required. |
Request body
In the request body, supply a JSON representation of the todoTask object.
The following table shows the properties that are required when you create the todoTask.
Property | Type | Description |
---|---|---|
id | String | The unique identifier of the task. Inherited from entity |
body | itemBody | The task body that typically contains information about the task. Note that only HTML type is supported. |
categories | String collection | The categories associated with the task. Each category corresponds to the displayName property of an outlookCategory that the user has defined. |
completedDateTime | dateTimeTimeZone | The date in the specified time zone that the task was finished. |
dueDateTime | dateTimeTimeZone | The date in the specified time zone that the task is to be finished. |
importance | importance | The importance of the event. Possible values are: low , normal , high . |
isReminderOn | Boolean | Set to true if an alert is set to remind the user of the task. |
recurrence | patternedRecurrence | The recurrence pattern for the task. |
reminderDateTime | dateTimeTimeZone | The date and time for a reminder alert of the task to occur. |
startDateTime | dateTimeTimeZone | The date in the specified time zone at which the task is scheduled to start. |
status | taskStatus | Indicates state or progress of the task. Possible values are: notStarted , inProgress , completed , waitingOnOthers , deferred . |
title | String | A brief description of the task. |
createdDateTime | DateTimeOffset | The date and time when the task was created. By default, it is in UTC. You can provide a custom time zone in the request header. |
lastModifiedDateTime | DateTimeOffset | The date and time when the task was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. |
bodyLastModifiedDateTime | DateTimeOffset | The date and time when the task body was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. |
Response
If successful, this method returns a 200 OK
response code and an updated todoTask object in the response body.
Examples
Request
PATCH https://graph.microsoft.com/v1.0/me/todo/lists/AAMkADA1MTHgwAAA=/tasks/721a35e2-35e2-721a-e235-1a72e2351a72
Content-Type: application/json
{
"dueDateTime":{
"dateTime":"2020-07-25T16:00:00",
"timeZone":"Eastern Standard Time"
}
}
Response
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#tasks/$entity",
"@odata.etag": "W/\"s8/ERWT3WEeFpBGD0bDgAA+TWq9g==\"",
"importance": "low",
"isReminderOn": false,
"status": "notStarted",
"title": "Shop for dinner",
"createdDateTime": "2020-07-22T10:39:03.7937971Z",
"lastModifiedDateTime": "2020-07-22T12:02:10.8835421Z",
"categories": [],
"id": "721a35e2-35e2-721a-e235-1a72e2351a72",
"body": {
"content": "",
"contentType": "text"
},
"dueDateTime": {
"dateTime": "2020-08-25T04:00:00.0000000",
"timeZone": "UTC"
}
}
Feedback
Submit and view feedback for