更新工作表属性

POST

/sheets/v2/spreadsheets/{spreadsheetToken}/sheets_batch_update

该接口用于根据 spreadsheetToken 更新工作表属性。
该接口和操作工作表的请求地址相同，但参数不同，调用前请仔细阅读文档。
user_id_type目前默认值为lark_id，2022年1月26日后将会调整默认值为open_id，且不再支持lark_id，请尽快适配！
userIds字段已废弃，2022年1月26日后将不再支持userIds字段，请使用userIDs作为替代。userIDs为需要增加保护范围编辑权限的用户id，id类型由user_id_type字段决定。
userIds字段已废弃，2022年1月26日后将不再支持userIds字段，请使用userIDs作为替代。userIDs为需要增加保护范围编辑权限的用户id，id类型由user_id_type字段决定。

请求参数

Authorization

Bearer Token

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

Query 参数

Body 参数application/json

示例

返回响应

🟢200成功

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST '/sheets/v2/spreadsheets//sheets_batch_update?user_id_type=lark_id' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "requests": [
    {
      "updateSheet": {
        "properties": {
          "sheetId": "string",
          "title": "string",
          "index": "int",
          "hidden": "bool",
          "frozenColCount": "int",
          "frozenRowCount": "int",
          "protect": {
            "lock": "LOCK",
            "lockInfo": "111",
            "userIDs": [
              "ou_xxxxxxxxxx"
            ]
          }
        }
      }
    }
  ]
}'

响应示例

{
    "code": 0,
    "msg": "Success",
    "data": {
        "replies": [
            {
                "updateSheet": {
                    "properties": {
                        "sheetId": "string",
                        "title": "string",
                        "index": 0,
                        "hidden": true,
                        "frozenColCount": 0,
                        "frozenRowCount": 0,
                        "protect": {
                            "lock": "LOCK",
                            "lockInfo": "",
                            "userIds": "",
                            "userIDs": [
                                "ou_xxxxxxxxx"
                            ]
                        }
                    }
                }
            }
        ]
    }
}

修改于 2025-10-21 06:22:03

操作工作表

增加保护范围