Update worksheet

Update the properties of worksheet object.

Prerequisites

The following scopes are required to execute this API:

* Files.ReadWrite

HTTP request

PATCH /workbook/worksheets/{id|name}

Optional request headers

Name Description
Authorization Bearer {token}. 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 The display name of the worksheet.
position int The zero-based position of the worksheet within the workbook.
visibility string The Visibility of the worksheet. Possible values are: Visible, Hidden, VeryHidden.

Response

If successful, this method returns a 200 OK response code and updated Worksheet object in the response body.

Example

Request

Here is an example of the request.

PATCH https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/worksheets/{id|name}
Content-type: application/json
Content-length: 100

{
  "position": 99,
  "name": "name-value",
  "visibility": "visibility-value"
}
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: 100

{
  "id": "id-value",
  "position": 99,
  "name": "name-value",
  "visibility": "visibility-value"
}