Skip to content

更新多维表格元数据

更新多维表格元数据,包括多维表格的名称、是否开启高级权限。

注意事项

  • 在线文档和电子表格中嵌入的多维表格、知识库中的多维表格不支持开启高级权限。
  • 此接口非原子操作,先修改多维表格名称,后开关高级权限,可能存在部分成功的情况。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/bitable/v1/apps/:app_token
HTTP MethodPUT
接口频率限制10 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可base:app: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 token。该接口仅支持存储在云空间文件夹中的多维表格,即 URL 以 feishu.cn/base 开头的多维表格形态。该类多维表格的 app_token 为 URL 下图高亮部分:

示例值:"appbcbWCzen6D8dezhoCH2RpMAh"

请求体

名称类型必填描述
namestring新的多维表格名称,不传则不更新名称。
示例值:"新的多维表格名称"
is_advancedboolean多维表格是否开启高级权限。不传则不更新设置。可选值: - true:开启高级权限 - false:关闭高级权限
示例值:true

请求体示例

json
{
    "name": "新的多维表格名称",
    "is_advanced": true
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ appdisplay_app_v2多维表格元数据
    └ app_tokenstring多维表格的唯一标识 app_token
    └ namestring多维表格的名称
    └ is_advancedboolean多维表格是否已开启高级权限
    └ time_zonestring文档时区

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "app": {
            "app_token": "appbcbWCzen6D8dezhoCH2RpMAh",
            "name": "新的多维表格名字",
            "is_advanced": true
        }
    }
}

错误码

HTTP状态码错误码描述排查建议
2001254000WrongRequestJson请求体错误
2001254001WrongRequestBody请求体错误
2001254002Fail内部错误,有疑问可咨询客服
2001254003WrongBaseTokenapp_token 错误
2001254010ReqConvError请求错误
2001254031InvalidAppName多维表格名称格式错误,长度不超过 100 个字符,不能包含 ? / \ * : [ ]
4001254036Base is copying, please try again later.多维表格副本复制中,稍后重试
2001254040BaseTokenNotFoundapp_token 不存在
2001254043RecordIdNotFoundrecord_id 不存在
2001254200internal error内部错误
2001254290TooManyRequest请求过快,稍后重试
2001254291Write conflict同一个数据表(table) 不支持并发调用写接口,请检查是否存在并发调用写接口。写接口包括:新增、修改、删除记录;新增、修改、删除字段;修改表单;修改视图等。
4001254301OperationTypeError多维表格未开启高级权限或不支持开启高级权限
4031254302Permission denied.无访问权限, 常由表格开启了高级权限造成, 请在高级权限设置中添加一个包含应用的群, 给予这个群读写权限
4031254304The role has no permissions.无权限
2001255001InternalError内部错误,有疑问可咨询客服
2001255002RpcError内部错误,有疑问可咨询客服
2001255003MarshalError序列化错误,有疑问可咨询客服
2001255004UmMarshalError反序列化错误
5041255040请求超时进行重试

补充错误码

错误码原因排查建议
1254061字段格式错误。确认对应字段类型参数格式是否正确。

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