Update plannerbucket

Update the properties of plannerbucket object.

Prerequisites

The following scopes are required to execute this API:

Group.ReadWrite.All

HTTP request

PATCH /planner/buckets/<id>

Optional request headers

Name Description
Authorization Bearer
If-Match Last known ETag value for the plannerBucket 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
name String Name of the bucket.
orderHint String Hint used to order items of this type in a list view. The format is defined as outlined here.
planId String Plan id to which the bucket belongs.

Response

If successful, this method returns a 200 OK response code and updated plannerBucket 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.

Example

Request

Here is an example of the request.

PATCH https://graph.microsoft.com/v1.0/planner/buckets/hsOf2dhOJkqyYYZEtdzDe2QAIUCR
Content-type: application/json
Content-length: 27
If-Match: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="

{
  "name": "Development"
}
Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

{
  "name": "Development",
  "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
  "orderHint": "85752723360752+",
  "id": "hsOf2dhOJkqyYYZEtdzDe2QAIUCR"
}