Range: merge


APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported.

Merge the range cells into one region in the worksheet.


One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Files.ReadWrite
Delegated (personal Microsoft account) Files.ReadWrite
Application Not supported.

HTTP request

POST /workbook/names/{name}/range/merge
POST /workbook/worksheets/{id|name}/range(address='<address>')/merge
POST /workbook/tables/{id|name}/columns/{id|name}/range/merge

Request headers

Name Description
Authorization Bearer {token}. Required.
Workbook-Session-Id Workbook session Id that determines if changes are persisted or not. Optional.

Request body

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

Parameter Type Description
across boolean Optional. Set true to merge cells in each row of the specified range as separate merged cells. The default value is false.


If successful, this method returns 200 OK response code. It does not return anything in the response body.


Here is an example of how to call this API.


Here is an example of the request.

POST https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/merge
Content-type: application/json
Content-length: 20

  "across": true

Here is an example of the response.

HTTP/1.1 200 OK

SDK sample code

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var across = true;

await graphClient.Me.Drive.Items["{id}"].Workbook.Names["{name}"]

Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.