Skip to content

更新数据表

更新数据表的名称。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/bitable/v1/apps/:app_token/tables/:table_id
HTTP MethodPATCH
接口频率限制10 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可base:table:update 更新数据表 bitable:app 查看、评论、编辑和管理多维表格

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

路径参数

名称类型描述
app_tokenstring多维表格 App 的唯一标识。不同形态的多维表格,其 app_token 的获取方式不同: - 如果多维表格的 URL 以 ==feishu.cn/base== 开头,该多维表格的 app_token 是下图高亮部分: app_token.png
- 如果多维表格的 URL 以 ==feishu.cn/wiki== 开头,你需调用知识库相关获取知识空间节点信息接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时,obj_token 字段的值才是多维表格的 app_token
了解更多,参考多维表格 app_token 获取方式
示例值:"XrgTb4y1haKYnasu0xXb1g7lcSg"
数据校验规则
- 最小长度:1 字符
table_idstring多维表格数据表的唯一标识。获取方式: - 你可通过多维表格 URL 获取 table_id,下图高亮部分即为当前数据表的 table_id - 也可通过列出数据表接口获取 table_id

示例值:"tbl1TkhyTWDkSoZ3"

请求体

名称类型必填描述
namestring数据表的新名称。 注意
- 名称中的首尾空格将会被去除。 - 数据表名称不可以包含 / \ ? * : [ ] 等特殊字符。 - 如果名称为空或和旧名称相同,接口仍然会返回成功,但是名称不会被更改。
示例值:"新的数据表名称"
数据校验规则
- 长度范围:1100 字符 - 正则校验:^[^\[\]\:\\\/\?\*]+$

请求体示例

json
{
    "name": "新的数据表名称"
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ namestring新的数据表名称

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "name": "新的数据表名称"
    }
}

错误码

HTTP状态码错误码描述排查建议
4001254001WrongRequestBody请求体错误
4001254002Fail内部错误,请联系技术支持
4001254003WrongBaseTokenapp_token 错误
4001254004WrongTableIdtable_id 错误
4001254013TableNameDuplicated表名重复
4031254036Base is copying, please try again later.复制多维表格为异步操作,该错误码表示当前多维表格仍在复制中,在复制期间无法操作当前多维表格。需要等待复制完成后再操作
4041254040BaseTokenNotFoundapp_token 不存在
4041254041TableIdNotFoundtable_id 不存在
4291254290TooManyRequest请求过快,稍后重试
4031254302Permission denied.调用身份缺少多维表格的高级权限。你需要为调用身份授予高级权限: - 对用户授予高级权限,你需要在多维表格页面右上方 分享 入口为当前用户添加可管理权限。image.png - 对应用授予高级权限,你需通过多维表格页面右上方 「...」 -> 「...更多」 ->「添加文档应用」 入口为应用添加可管理权限。 image.png 注意: 在 添加文档应用 前,你需确保目标应用至少开通了一个多维表格的 API 权限。否则你将无法在文档应用窗口搜索到目标应用。 - 你也可以在 多维表格高级权限设置 中添加用户或一个包含应用的群组, 给予这个群自定义的读写等权限。
5001255001InternalError内部错误,请联系技术支持

内容来源:飞书开放平台 · 自动爬取整理