飞书 API

操作工作表

POST

/open-apis/sheets/v2/spreadsheets/{spreadsheetToken}/sheets_batch_update

自建应用商店应用

该接口用于根据 spreadsheetToken 操作表格，如增加工作表，复制工作表、删除工作表。
该接口和更新工作表属性的请求地址相同，但参数不同，调用前请仔细阅读文档。

请求示例

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": [
    {
      "addSheet": {
        "properties": {
          "title": "string",
          "index": 0
        }
      }
    },
    {
      "copySheet": {
        "source": {
          "sheetId": "string"
        },
        "destination": {
          "title": "string"
        }
      }
    },
    {
      "deleteSheet": {
        "sheetId": "string"
      }
    }
  ]
}'

响应示例

{
  "code": 0,
  "msg": "Success",
  "data": {
    "replies": [
      {
        "addSheet": {
          "properties": {
            "sheetId": "string",
            "title": "string",
            "index": 0
          }
        },
        "copySheet": {
          "properties": {
            "sheetId": "string",
            "title": "string",
            "index": 0
          }
        },
        "deleteSheet": {
          "result": true,
          "sheetId": "string"
        }
      }
    ]
  }
}

请求参数

Path 参数

spreadsheetToken

string

必需

spreadsheet 的 token，获取方式见在线表格开发指南

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 {3}]

必需

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

addSheet

object

增加工作表

可选

copySheet

object

复制工作表

可选

deleteSheet

object

删除 sheet

可选

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

replies

array [object {3}]

必需

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

修改于 2022-02-11 12:16:20

更新表格属性

更新工作表属性