Update bucket

Update the properties of bucket object.

Prerequisites

One of the following scopes is required to execute this API:

Group.ReadWrite.All

HTTP request

PATCH /buckets/{id}

Request headers

Name Type Description
Authorization string Value should be set to "Bearer (access-token)"
If-Match string Value should be set to the ETag of the object
Prefer string Value should be set to "return=representation" so that the updated object is returned in the response. This is advised so that the client can get the new ETag value of the updated object without doing an additional GET

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 Used to set the relative order of the buckets in the task board view. Consider three buckets in the order of: 'E', 'F', 'G'. To make 'F' the first bucket, set its 'orderHint' to smaller than that of 'x'. The comparison is an ordinal string comparison.
planId String Plan id to which the bucket belongs.

Response

If successful, this method returns a 204 No Content response code.

Example

Request

Here is an example of the request.

PATCH https://graph.microsoft.com/beta/buckets/{id}
Content-type: application/json
Content-length: 108
If-Match: W/"JzEtMDAwMDAwMDAwMDAwMDAwOC8yMDE1LTEwLTIyVDE4OjExOjU2LjExMzU1NDYrMDA6MDAn"

{
  "name": "name-value",
  "planId": "planId-value",
  "orderHint": "orderHint-value",
  "id": "id-value"
}
Response

Here is an example of the response.

HTTP/1.1 204 No Content

To get the updated object, use the Prefer header. See Request Headers above.