worksheetCollection: add

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Add a new worksheet to the workbook. The worksheet is added at the end of existing worksheets. If you want to activate the newly added worksheet, call ".activate() on it.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) Files.ReadWrite Not available.
Delegated (personal Microsoft account) Files.ReadWrite Not available.
Application Not supported. Not supported.

HTTP request

POST /me/drive/items/{id}/workbook/worksheets/add
POST /me/drive/root:/{item-path}:/workbook/worksheets/add

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Workbook-Session-Id Workbook session ID that determines whether changes are persisted. Optional.

Request body

In the request body, provide a JSON object with the following parameters.

Parameter Type Description
name string Optional. The name of the worksheet to be added. If specified, name should be unique. If not specified, Excel determines the name of the new worksheet.

Response

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

Examples

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/worksheets/add
Content-type: application/json

{
  "name": "name-value"
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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

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