修改电子表格属性
该接口用于修改电子表格的属性。目前支持修改电子表格标题。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/sheets/v3/spreadsheets/:spreadsheet_token |
| HTTP Method | PATCH |
| 接口频率限制 | 20 次/分钟 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | drive:drive 查看、评论、编辑和管理云空间中所有文件 sheets:spreadsheet 查看、评论、编辑和管理电子表格 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token |
| Content-Type | string | 是 | 固定值："application/json; charset=utf-8" |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
spreadsheet_token | string | 电子表格的 token。可通过以下两种方式获取。了解更多，参考电子表格概述。 - 电子表格的 URL：https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== - 调用获取文件夹中的文件清单 示例值："Iow7sNNEphp3WbtnbCscPqabcef" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
title | string | 否 | 新的电子表格标题。参数为空时，表格标题将显示为“未命名表格”或本地语言环境对应内容。 示例值："Sales sheet" |
请求体示例
json
{
"title": "Sales sheet"
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码，非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1310251 | Invalid Parameter | 参考响应体中的错误提示 |
| 400 | 1310213 | Permission Fail | 没有文档相应权限。参考云文档常见问题问题 2 和问题 3 开通应用权限和文档权限 |
| 400 | 1310249 | Spreadsheet Deleted | 恢复表格后重试 |
| 400 | 1310250 | Title Not Pass | 标题违规，使用其他的标题 |
| 400 | 1310214 | SpreadSheet Not Found | 检查表格 token |
| 500 | 1315201 | Server Error | 服务内部错误，详询客服 |
| 500 | 1315203 | Server Error | 服务内部错误，详询客服 |
| 500 | 1315210 | Server Error | 服务内部错误，详询客服 |