飞书 API

更新工作表属性

POST

https://open.feishu.cn/open-apis/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字段决定。

错误码

具体可参考：服务端错误码说明

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://open.feishu.cn/open-apis/sheets/v2/spreadsheets//sheets_batch_update' \
--header 'Authorization;' \
--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",
              "sheetName": "",
              "permId": "",
              "userIDs": [
                "ou_xxxxxxxxx"
              ]
            }
          }
        }
      }
    ]
  }
}

请求参数

Path 参数

spreadsheetToken

string

必需

Query 参数

user_id_type

string

可选

请求的用户id类型，可选open_id,union_id

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

Body 参数application/json

requests

array [object {1}]

必需

请求操作，支持增、删、复制工作表，三个操作选一个

updateSheet

object

更新工作表

可选

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

replies

array [object {1}]

必需

返回本次相关操作工作表的结果

修改于 2023-01-13 10:15:56

操作工作表

增加行列

更新工作表属性

查询参数#

请求体#

错误码#

请求参数

返回响应

查询参数

请求体

错误码