Range: merge

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

Merge the range cells into one region in the worksheet.


The following scopes are required to execute this API:

* Files.ReadWrite

HTTP request

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

Request headers

Name Description
Authorization Bearer {token}. Required.

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