Range: merge

• 5/4/2019
• 2 minutes to read
• Contributors
  • 
  • 
  • 
  • 
  • 
  • all

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.

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

Request body

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

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

SDK sample code

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var across = true;

await graphClient.Me.Drive.Items["{id}"].Workbook.Names["{name}"]
	.Range()
	.Merge(across)
	.Request()
	.PostAsync();

const options = {
	authProvider,
};

const client = Client.init(options);

const merge = {
  across: true
};

let res = await client.api('/me/drive/items/{id}/workbook/names/{name}/range/merge')
	.version('beta')
	.post(merge);

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