Range: merge
- 2 minutes to read
-
Contributors
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.
Permissions
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. |
Response
If successful, this method returns 200 OK response code. It does not return anything in the response body.
Example
Here is an example of how to call this API.
Request
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
}
Response
Here is an example of the response.
HTTP/1.1 200 OK