> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Merge cells

> Call this API to merge cells in a specified range of a DingTalk Spreadsheet, supporting full, by-row, and by-column modes; only the top-left cell data is retained.

Call this API to merge multiple cells within a specified range in a DingTalk Spreadsheet into a single cell. This is useful for scenarios such as creating cross-column header titles or merging rows of the same category. Three merge modes are supported: merge all, merge by row, and merge by column. After merging, only the data in the top-left cell is retained, and the content of other cells is cleared. The API returns the address of the merged cells.

## Request

### Basic information

| Field              | Value                                                                                                  |
| ------------------ | ------------------------------------------------------------------------------------------------------ |
| HTTP URL           | `https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/ranges/{rangeAddress}/merge` |
| HTTP Method        | POST                                                                                                   |
| Supported app type | appType-Internal app                                                                                   |
| Permissions        | permission-Document.Workbook.Write-DingTalk Spreadsheet write permission                               |

### Request headers

| Name                        | Type   | Required | Description                                                                                                                                                                     |
| --------------------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| x-acs-dingtalk-access-token | String | Yes      | The access credential for calling this API. To obtain it, call the [Get the access token of an internal app](/open/development/obtain-the-access-token-of-an-internal-app) API. |

### Path parameters

| Name         | Type   | Required | Description                                                                                                                                                                                                                                                                                                                                                             |
| ------------ | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| workbookId   | String | Yes      | The ID of the spreadsheet file. The `nodeId` (`dentryUuid`) returned by the [Knowledge Base API](/open/development/knowledge-base-overview) is the `workbookId` of the spreadsheet. To obtain it, call the [Get a node](/open/development/get-knowledge-base-acquisition-node) or [Create a Knowledge Base document](/open/development/create-team-space-document) API. |
| sheetId      | String | Yes      | The worksheet ID or title. To obtain the ID and title of a worksheet, call the [Get all worksheets](/open/development/obtain-all-worksheets) API.                                                                                                                                                                                                                       |
| rangeAddress | String | Yes      | The range of cells to merge, in the format of `top-left cell:bottom-right cell`. Example: B2:C3.                                                                                                                                                                                                                                                                        |

### Query parameters

| Name       | Type   | Required | Description                                                                                                                                                                                                               |
| ---------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| operatorId | String | Yes      | The unionId of the operator. To obtain it, call the [Query user details](/open/development/query-user-details) API. If the operator does not have permission, the API returns the error `The operator has no permission`. |

### Request body

| Name      | Type   | Required | Description                                                                                                                                                                                                                                                                                                                          |
| --------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| mergeType | String | No       | The merge mode. Valid values:   - **mergeAll**: Merges all cells (default). - **mergeRows**: Merges by row. Adjacent cells in the same row within the selected range are merged into a single cell. - **mergeColumns**: Merges by column. Adjacent cells in the same column within the selected range are merged into a single cell. |

### Request example

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
POST /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/ranges/A1:B1/merge?operatorId=ppgAQuxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:token:f86e0bxxx
Content-Type:application/json

{
  "mergeType" : "mergeRows"
}
```

Java

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client with a Token</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalkdoc_1_0.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkdoc_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkdoc_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkdoc_1_0.models.MergeRangeHeaders mergeRangeHeaders = new com.aliyun.dingtalkdoc_1_0.models.MergeRangeHeaders();
        mergeRangeHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.MergeRangeRequest mergeRangeRequest = new com.aliyun.dingtalkdoc_1_0.models.MergeRangeRequest()
                .setOperatorId("ppgAQuxxx")
                .setMergeType("mergeRows");
        try {
            client.mergeRangeWithOptions("e54Lq3xxx", "Sheet1", "A1:B1", mergeRangeRequest, mergeRangeHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains the code and message attributes, which help locate the issue
            }

        } catch (Exception _err) {
            TeaException err = new TeaException(_err.getMessage(), _err);
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains the code and message attributes, which help locate the issue
            }

        }        
    }
}
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
import json

from typing import List

from alibabacloud_dingtalk.doc_1_0.client import Client as dingtalkdoc_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.doc_1_0 import models as dingtalkdoc__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> dingtalkdoc_1_0Client:
        """
        Initialize the account Client with a Token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkdoc_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        merge_range_headers = dingtalkdoc__1__0_models.MergeRangeHeaders()
        merge_range_headers.x_acs_dingtalk_access_token = '<your access token>'
        merge_range_request = dingtalkdoc__1__0_models.MergeRangeRequest(
            operator_id='ppgAQuxxx',
            merge_type='mergeRows'
        )
        try:
            client.merge_range_with_options('e54Lq3xxx', 'Sheet1', 'A1:B1', merge_range_request, merge_range_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message attributes, which help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        merge_range_headers = dingtalkdoc__1__0_models.MergeRangeHeaders()
        merge_range_headers.x_acs_dingtalk_access_token = '<your access token>'
        merge_range_request = dingtalkdoc__1__0_models.MergeRangeRequest(
            operator_id='ppgAQuxxx',
            merge_type='mergeRows'
        )
        try:
            await client.merge_range_with_options_async('e54Lq3xxx', 'Sheet1', 'A1:B1', merge_range_request, merge_range_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message attributes, which help locate the issue
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
```

PHP

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\MergeRangeHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\MergeRangeRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with a Token
     * @return Dingtalk Client
     */
    public static function createClient(){
        $config = new Config([]);
        $config->protocol = "https";
        $config->regionId = "central";
        return new Dingtalk($config);
    }

    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        $client = self::createClient();
        $mergeRangeHeaders = new MergeRangeHeaders([]);
        $mergeRangeHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $mergeRangeRequest = new MergeRangeRequest([
            "operatorId" => "ppgAQuxxx",
            "mergeType" => "mergeRows"
        ]);
        try {
            $client->mergeRangeWithOptions("e54Lq3xxx", "Sheet1", "A1:B1", $mergeRangeRequest, $mergeRangeHeaders, new RuntimeOptions([]));
        }
        catch (Exception $err) {
            if (!($err instanceof TeaError)) {
                $err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
            }
            if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
                // err contains the code and message attributes, which help locate the issue
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));
```

Go

```go theme={"theme":{"light":"github-light","dark":"github-dark"}}
package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkdoc_1_0  "github.com/alibabacloud-go/dingtalk/doc_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

// Description:
// 
// Initialize the account Client with a Token
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *dingtalkdoc_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkdoc_1_0.Client{}
  _result, _err = dingtalkdoc_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  mergeRangeHeaders := &dingtalkdoc_1_0.MergeRangeHeaders{}
  mergeRangeHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  mergeRangeRequest := &dingtalkdoc_1_0.MergeRangeRequest{
    OperatorId: tea.String("ppgAQuxxx"),
    MergeType: tea.String("mergeRows"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.MergeRangeWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), tea.String("A1:B1"), mergeRangeRequest, mergeRangeHeaders, &util.RuntimeOptions{})
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var err = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      err = _t
    } else {
      err.Message = tea.String(tryErr.Error())
    }
    if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
      // err contains the code and message attributes, which help locate the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
```

Node.js

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkdoc_1_0 = require('@alicloud/dingtalk/doc_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * Initialize the account Client with a Token
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkdoc_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let mergeRangeHeaders = new dingtalkdoc_1_0.MergeRangeHeaders({ });
    mergeRangeHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let mergeRangeRequest = new dingtalkdoc_1_0.MergeRangeRequest({
      operatorId: 'ppgAQuxxx',
      mergeType: 'mergeRows',
    });
    try {
      await client.mergeRangeWithOptions('e54Lq3xxx', 'Sheet1', 'A1:B1', mergeRangeRequest, mergeRangeHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains the code and message attributes, which help locate the issue
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
```

C#

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
using Newtonsoft.Json;
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>Initialize the account Client with a Token</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalkdoc_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkdoc_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.MergeRangeHeaders mergeRangeHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.MergeRangeHeaders();
            mergeRangeHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.MergeRangeRequest mergeRangeRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.MergeRangeRequest
            {
                OperatorId = "ppgAQuxxx",
                MergeType = "mergeRows",
            };
            try
            {
                client.MergeRangeWithOptions("e54Lq3xxx", "Sheet1", "A1:B1", mergeRangeRequest, mergeRangeHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains the code and message attributes, which help locate the issue
                }
            }
            catch (Exception _err)
            {
                TeaException err = new TeaException(new Dictionary<string, object>
                {
                    { "message", _err.Message }
                });
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains the code and message attributes, which help locate the issue
                }
            }
        }

    }
}
```

## Response

### Response body

| Name       | Type   | Description                                                                                |
| ---------- | ------ | ------------------------------------------------------------------------------------------ |
| a1Notation | String | The merged cell range, in the format of `top-left cell:bottom-right cell`. Example: B2:C3. |

### Response body example

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
Content-Type:application/json

{
  "a1Notation" : "A1:B1"
}
```

### Error codes

If an error is returned when you call this API, find the solution in the [Global error codes](/open/development/server-api-error-codes-1) document based on the error message.

| HttpCode | Error code                                 | Error message                                                                                                                                       | Description                                                             |
| -------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| 400      | invalidRequest.inputArgs.workbookIdIllegal | The workbookId is illegal.                                                                                                                          | The workbookId is invalid.                                              |
| 400      | invalidRequest.inputArgs.unionIdIllegal    | The operatorId is illegal.                                                                                                                          | The operatorId is invalid.                                              |
| 400      | invalidRequest.inputArgs.invalid           | %s                                                                                                                                                  | The request parameter is invalid. See the error message for details.    |
| 403      | forbidden.operationIllegal                 | %s                                                                                                                                                  | The request action is invalid. See the error message for details.       |
| 403      | forbidden.accessDenied                     | The operator has no permission.                                                                                                                     | The current user does not have permission to perform this action.       |
| 403      | forbidden.document.sizeOverLimit           | The document size is over limit and the server is unable to complete your request. Retry is unlikely to work unless the document size is decreased. | The spreadsheet content is too large. Reduce the content and try again. |
| 404      | invalidRequest.resource.notFound           | %s                                                                                                                                                  | The request failed because the requested resource cannot be found.      |
| 500      | internalError                              | The server encountered an internal error and was unable to complete your request. Please try again later.                                           | An internal server error occurred. Try again later.                     |
| 503      | serviceBusy                                | The server is busy and unable to complete your request. Please try again later.                                                                     | The server is busy. Try again later.                                    |