Update a worksheet - DingTalk Help Center

Call this API to modify the metadata of a specified worksheet in a DingTalk Spreadsheet, including the worksheet name, visibility, and the number of frozen rows and columns. This API is suitable for programmatically managing worksheet configurations and supports updating multiple attributes in a single request. The worksheet id is returned after the update.

Request

Basic information

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

Request header

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential for calling this API. To obtain the credential, call the Get 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 is the `workbookId` of the spreadsheet. To obtain it, call the Get node or Create a Knowledge Base document API.
sheetId	String	Yes	The ID or title of the worksheet. To obtain the id and title of a worksheet, call the Get all worksheets API.

Query parameters

Name	Type	Required	Description
operatorId	String	Yes	The unionId of the operator. To obtain it, call the Query user details API. If the operator does not have the required permissions, the API returns the error `The operator has no permission`.

Request body

Name	Type	Required	Description
frozenRowCount	Long	No	The row index at which to freeze rows. Starts from 1. A value of 0 means no rows are frozen. For example, set this value to 3 to freeze rows 1 through 3.
frozenColumnCount	Long	No	The column index at which to freeze columns. Starts from 1. A value of 0 means no columns are frozen. For example, set this value to 3 to freeze columns 1 through 3.
visibility	String	No	Whether to hide the worksheet. Valid values: - visible: Show. - hidden: Hide.
name	String	No	The new worksheet name.

Request example

HTTP

PUT /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1?operatorId=ppgAxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:f86e0bxxx
Content-Type:application/json

{
  "frozenRowCount" : 1,
  "frozenColumnCount" : 1,
  "visibility" : "hidden",
  "name" : "Sheet2"
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client using 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.UpdateSheetHeaders updateSheetHeaders = new com.aliyun.dingtalkdoc_1_0.models.UpdateSheetHeaders();
        updateSheetHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.UpdateSheetRequest updateSheetRequest = new com.aliyun.dingtalkdoc_1_0.models.UpdateSheetRequest()
                .setOperatorId("ppgAxxx")
                .setFrozenRowCount(1L)
                .setFrozenColumnCount(1L)
                .setVisibility("hidden")
                .setName("Sheet2");
        try {
            client.updateSheetWithOptions("e54Lq3xxx", "Sheet1", updateSheetRequest, updateSheetHeaders, 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 code and message attributes that 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 code and message attributes that help locate the issue
            }

        }        
    }
}

Python

# -*- 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 using 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()
        update_sheet_headers = dingtalkdoc__1__0_models.UpdateSheetHeaders()
        update_sheet_headers.x_acs_dingtalk_access_token = '<your access token>'
        update_sheet_request = dingtalkdoc__1__0_models.UpdateSheetRequest(
            operator_id='ppgAxxx',
            frozen_row_count=1,
            frozen_column_count=1,
            visibility='hidden',
            name='Sheet2'
        )
        try:
            client.update_sheet_with_options('e54Lq3xxx', 'Sheet1', update_sheet_request, update_sheet_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes that help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        update_sheet_headers = dingtalkdoc__1__0_models.UpdateSheetHeaders()
        update_sheet_headers.x_acs_dingtalk_access_token = '<your access token>'
        update_sheet_request = dingtalkdoc__1__0_models.UpdateSheetRequest(
            operator_id='ppgAxxx',
            frozen_row_count=1,
            frozen_column_count=1,
            visibility='hidden',
            name='Sheet2'
        )
        try:
            await client.update_sheet_with_options_async('e54Lq3xxx', 'Sheet1', update_sheet_request, update_sheet_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes that help locate the issue
                pass

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

PHP

<?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\UpdateSheetHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\UpdateSheetRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using 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();
        $updateSheetHeaders = new UpdateSheetHeaders([]);
        $updateSheetHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $updateSheetRequest = new UpdateSheetRequest([
            "operatorId" => "ppgAxxx",
            "frozenRowCount" => 1,
            "frozenColumnCount" => 1,
            "visibility" => "hidden",
            "name" => "Sheet2"
        ]);
        try {
            $client->updateSheetWithOptions("e54Lq3xxx", "Sheet1", $updateSheetRequest, $updateSheetHeaders, 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 code and message attributes that 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));

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 using 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
  }

  updateSheetHeaders := &dingtalkdoc_1_0.UpdateSheetHeaders{}
  updateSheetHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  updateSheetRequest := &dingtalkdoc_1_0.UpdateSheetRequest{
    OperatorId: tea.String("ppgAxxx"),
    FrozenRowCount: tea.Int64(1),
    FrozenColumnCount: tea.Int64(1),
    Visibility: tea.String("hidden"),
    Name: tea.String("Sheet2"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.UpdateSheetWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), updateSheetRequest, updateSheetHeaders, &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 code and message attributes that help locate the issue
    }

  }
  return _err
}

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

Node.js

'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 using 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 updateSheetHeaders = new dingtalkdoc_1_0.UpdateSheetHeaders({ });
    updateSheetHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let updateSheetRequest = new dingtalkdoc_1_0.UpdateSheetRequest({
      operatorId: 'ppgAxxx',
      frozenRowCount: 1,
      frozenColumnCount: 1,
      visibility: 'hidden',
      name: 'Sheet2',
    });
    try {
      await client.updateSheetWithOptions('e54Lq3xxx', 'Sheet1', updateSheetRequest, updateSheetHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains code and message attributes that help locate the issue
      }

    }    
  }

}

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

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 using 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.UpdateSheetHeaders updateSheetHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateSheetHeaders();
            updateSheetHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateSheetRequest updateSheetRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateSheetRequest
            {
                OperatorId = "ppgAxxx",
                FrozenRowCount = 1,
                FrozenColumnCount = 1,
                Visibility = "hidden",
                Name = "Sheet2",
            };
            try
            {
                client.UpdateSheetWithOptions("e54Lq3xxx", "Sheet1", updateSheetRequest, updateSheetHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message attributes that 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 code and message attributes that help locate the issue
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
id	String	The worksheet id.

Response body example

HTTP/1.1 200 OK
Content-Type:application/json

{
  "id" : "sheet_id"
}

Error codes

If an error is returned when you call this API, look up the solution in the Global error codes document based on the error message.

HttpCode	Error code	Error message	Description
400	invalidRequest.inputArgs.invalid	%s	The request parameter is invalid. See the error message for details.
400	invalidRequest.inputArgs.workbookIdIllegal	The workbookId is illegal.	The workbookId is invalid.
400	invalidRequest.resource.notWorkbook	%s	The document type is not supported. Check the workbookId.
400	invalidRequest.inputArgs.unionIdIllegal	The operatorId is illegal.	The operatorId is invalid.
403	forbidden.accessDenied	The operator has no permission.	The current user does not have permission to perform this action.
403	forbidden.acrossOrg	%s	The request is invalid. Check whether the target document belongs to the organization specified by the access token.
403	forbidden.operationIllegal	%s	The request action is invalid. See the error message for details.
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. Try to reduce the spreadsheet content.
404	invalidRequest.resource.notFound	%s	The request failed because the target resource cannot be found.
500	serviceBusy	The server is busy and unable to complete your request. Please try again later.	The service is busy. Try again later.
500	internalError	The server encountered an internal error and was unable to complete your request. Please try again later.	An internal service error occurred. Try again later.

​Request

​Basic information

​Request header

​Path parameters

​Query parameters

​Request body

​Request example

​Response

​Response body

​Response body example

​Error codes