Update plannerAssignedToTaskBoardTaskFormat

Namespace: microsoft.graph

Update the properties of plannerAssignedToTaskBoardTaskFormat object.


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, Group.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application Tasks.ReadWrite.All

HTTP request

PATCH /planner/tasks/{id}/assignedToTaskBoardFormat

Optional request headers

Name Description
Authorization Bearer {token}. Required.
If-Match Last known ETag value for plannerAssignedToTaskBoardTaskFormat to be updated. Required.

Request body

In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.

Property Type Description
orderHintsByAssignee plannerOrderHintsByAssignee Dictionary of hints used to order tasks on the AssignedTo view of the Task Board. The key of each entry is one of the users the task is assigned to and the value is the order hint. The format of each value is defined as outlined here.
unassignedOrderHint String Hint value used to order the task on the AssignedTo view of the Task Board when the task is not assigned to anyone, or if the orderHintsByAssignee dictionary does not provide an order hint for the user the task is assigned to. The format is defined as outlined here.


If successful, this method returns 204 No Content response and empty content. If the request specifies Prefer header with return=representation preference, then this method returns a 200 OK response code and updated plannerAssignedToTaskBoardTaskFormat object in the response body.

This method can return any of the HTTP status codes. The most common errors that apps should handle for this method are the 400, 403, 404, 409, and 412 responses. For more information about these errors, see Common Planner error conditions.



Here is an example of the request.

PATCH https://graph.microsoft.com/v1.0/planner/tasks/{task-id}/assignedToTaskBoardFormat
Content-type: application/json
Prefer: return=representation

  "orderHintsByAssignee": {
    "aaa27244-1db4-476a-a5cb-004607466324": "8566473P 957764Jk!"

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

HTTP/1.1 200 OK
Content-type: application/json

  "unassignedOrderHint": "RWk1",
  "orderHintsByAssignee": {
  "id": "01gzSlKkIUSUl6DF_EilrmQAKDhh"