lark-base-record-batch-update.md 2.3 KB

base +record-batch-update (batch update)

前置条件: 先阅读 ../lark-shared/SKILL.md 了解认证、全局参数和安全规则。

批量更新记录(将同一份 patch 批量应用到一批 record_id_list)。

推荐命令

lark-cli base +record-batch-update \
  --base-token XXXXXX \
  --table-id tblXXX \
  --json '{"record_id_list":["recXXX"],"patch":{"field_id_or_name":"value"}}'
lark-cli base +record-batch-update \
  --base-token XXXXXX \
  --table-id tblXXX \
  --json @batch-update.json

参数

参数 必填 说明
--base-token <token> Base Token
--table-id <id_or_name> 表 ID 或表名
--json <body> 批量更新请求体,必须是 JSON 对象。支持直接传 JSON 字符串,或 @<file_path> 从文件读取

生成 patch 前必看

API 入参详情

HTTP 方法和路径:

POST /open-apis/base/v3/bases/:base_token/tables/:table_id/records/batch_update

--json 结构

对象形态:{"record_id_list":[...],"patch":{...}}

字段 类型 必填 说明
record_id_list string[] 要更新的记录 ID 列表(单次最多 200 条)
patch object 同一份字段更新对象,会应用到 record_id_list 内所有记录

返回重点

返回结构如下(其中 update 可与 +record-list 的单行字段对象结构对齐):

字段 类型 说明
record_id_list string[] 本次更新到的记录 ID 列表
update object 本次应用的字段更新结果;可能为空对象
ignored_fields {id,name,reason}[] 可选,被忽略字段信息

坑点

  • ⚠️ --json 必须是对象。
  • ⚠️ 该接口是“同值批量更新”:同一请求内所有 record_id_list 都会应用同一份 patch
  • ⚠️ record_id_list 最大 200 条,超过会被接口校验拒绝。
  • ⚠️ 命令不会自动做字段/行映射转换,传什么就发什么。

参考