Skip to main content

planner task set

Updates a Microsoft Planner task

Usage​

m365 planner task set [options]

Options​

-i, --id <id>

ID of the task.

-t, --title [title]

New title of the task.

--bucketId [bucketId]

ID of the bucket to move the task to. Specify either bucketId or bucketName when using title.

--bucketName [bucketName]

Name of the bucket to move the task to. The bucket needs to exist in the selected plan. Specify either bucketId or bucketName when using title.

--planId [planId]

ID of the plan to which the bucket belongs to. Specify either planId or planTitle when using bucketName.

--planTitle [planTitle]

Title of the plan to which the bucket belongs to. Specify either planId or planTitle when using bucketName.

--ownerGroupId [ownerGroupId]

ID of the group to which the plan belongs. Specify ownerGroupId or ownerGroupName when using planTitle.

--ownerGroupName [ownerGroupName]

Name of the group to which the plan belongs. Specify ownerGroupId or ownerGroupName when using planTitle.

--startDateTime [startDateTime]

The date and time when the task started. This should be defined as a valid ISO 8601 string. 2021-12-16T18:28:48.6964197Z

--dueDateTime [dueDateTime]

The date and time when the task is due. This should be defined as a valid ISO 8601 string. 2021-12-16T18:28:48.6964197Z

--percentComplete [percentComplete]

Percentage of task completion. Number between 0 and 100.

--assignedToUserIds [assignedToUserIds]

Comma-separated IDs of the assignees that should be added to the task assignment. Specify either assignedToUserIds or assignedToUserNames but not both.

--assignedToUserNames [assignedToUserNames]

Comma-separated UPNs of the assignees that should be added to the task assignment. Specify either assignedToUserIds or assignedToUserNames but not both.

--description [description]

Description of the task.

--orderHint [orderHint]

Hint used to order items of this type in a list view.

--assigneePriority [assigneePriority]

Hint used to order items of this type in a list view.

--appliedCategories [appliedCategories]

Comma-separated categories that should be added to the task.

--priority [priority]

Priority of the task: Urgent, Important, Medium, Low. Or an integer between 0 and 10 (check remarks section for more info).

-h, --help [help]

Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, response, full. Default is full.

--query [query]

JMESPath query string. See http://jmespath.org/ for more information and examples.

-o, --output [output]

Output type. json, text, csv, md. Default json.

--verbose

Runs command with verbose logging.

--debug

Runs command with debug logging.

Remarks​

When you specify the value for percentComplete, consider the following:

  • when set to 0, the task is considered Not started
  • when set between 1 and 99, the task is considered In progress
  • when set to 100, the task is considered Completed

When you specify an integer value for priority, consider the following:

  • values 0 and 1 are interpreted as Urgent
  • values 2, 3 and 4 are interpreted as Important
  • values 5, 6 and 7 are interpreted as Medium
  • values 8, 9 and 10 are interpreted as Low

You can add up to 6 categories to the task. An example to add category1 and category3 would be category1,category3.

When using description with a multiple lines value, use the new line character of the shell you are using to indicate line breaks. For PowerShell this is `n. For Zsh or Bash use \n with a $ in front. E.g. $"Line 1\nLine 2".

Examples​

Updates a Microsoft Planner task name to My Planner Task for the task with the ID Z-RLQGfppU6H3663DBzfs5gAMD3o

m365 planner task set --id "Z-RLQGfppU6H3663DBzfs5gAMD3o" --title "My Planner Task"

Moves a Microsoft Planner task with the ID Z-RLQGfppU6H3663DBzfs5gAMD3o to the bucket named My Planner Bucket. Based on the plan with the title My Planner Plan owned by the group My Planner Group

m365 planner task set  --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"

Marks a Microsoft Planner task with the ID Z-RLQGfppU6H3663DBzfs5gAMD3o as 50% complete and assigned to categories 1 and 3.

m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2"  --percentComplete 50 --appliedCategories "category1,category3"

Response​

Standard response​

{
  "planId": "oUHpnKBFekqfGE_PS6GGUZcAFY7b",
  "bucketId": "vncYUXCRBke28qMLB-d4xJcACtNz",
  "title": "Important task",
  "orderHint": "8585269241124027581",
  "assigneePriority": "",
  "percentComplete": 50,
  "startDateTime": "2023-01-20T00:00:00Z",
  "createdDateTime": "2023-01-25T21:39:33.0748226Z",
  "dueDateTime": "2023-02-15T00:00:00Z",
  "hasDescription": false,
  "previewType": "automatic",
  "completedDateTime": null,
  "completedBy": null,
  "referenceCount": 0,
  "checklistItemCount": 0,
  "activeChecklistItemCount": 0,
  "conversationThreadId": null,
  "priority": 5,
  "id": "D-ys8Ef4kEuwYG4r68Um3pcAAe9M",
  "createdBy": {
    "user": {
      "displayName": null,
      "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
    },
    "application": {
      "displayName": null,
      "id": "31359c7f-bd7e-475c-86db-fdb8c937548e"
    }
  },
  "appliedCategories": {},
  "assignments": {}
}

description, previewType response​

{
  "planId": "oUHpnKBFekqfGE_PS6GGUZcAFY7b",
  "bucketId": "vncYUXCRBke28qMLB-d4xJcACtNz",
  "title": "Important task",
  "orderHint": "8585269241124027581",
  "assigneePriority": "",
  "percentComplete": 50,
  "startDateTime": "2023-01-20T00:00:00Z",
  "createdDateTime": "2023-01-25T21:39:33.0748226Z",
  "dueDateTime": "2023-02-15T00:00:00Z",
  "hasDescription": true,
  "previewType": "automatic",
  "completedDateTime": null,
  "completedBy": null,
  "referenceCount": 0,
  "checklistItemCount": 0,
  "activeChecklistItemCount": 0,
  "conversationThreadId": null,
  "priority": 5,
  "id": "D-ys8Ef4kEuwYG4r68Um3pcAAe9M",
  "createdBy": {
    "user": {
      "displayName": null,
      "id": "b2091e18-7882-4efe-b7d1-90703f5a5c65"
    },
    "application": {
      "displayName": null,
      "id": "31359c7f-bd7e-475c-86db-fdb8c937548e"
    }
  },
  "appliedCategories": {},
  "assignments": {},
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
  "references": {},
  "checklist": {}
}

More information​