V2
追加块子块
向一个 block 追加新的直接子块,并可指定插入位置。
追加块子块
适用场景
当你要向某个 block 追加新的直接子块时使用这个接口。它适合增量写入正文结构,也支持控制插入位置。
接口信息
| 项目 | 内容 |
|---|---|
| 方法 | PATCH |
| 路径 | /v2/blocks/:block_id/children |
| 请求体 | children 追加参数 |
| 返回 | list |
| Scope | blocks.write |
权限要求
需要 blocks.write。
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
block_id | string | 是 | 父 block ID。 |
children | block input[] | 是 | 要追加的直接子块。 |
after | string | 否 | 插入位置,指定为某个现有子块 ID。 |
请求体示例:
{
"children": [
{
"object": "block",
"type": "to_do",
"to_do": {
"rich_text": [
{
"type": "text",
"text": {
"content": "补充监控告警"
}
}
],
"checked": false
}
}
],
"after": "12121212-1212-4212-8212-121212121212"
}
响应结果
{
"object": "list",
"results": [
{
"object": "block",
"id": "14141414-1414-4414-8414-141414141414",
"parent": {
"type": "page_id",
"page_id": "99999999-9999-4999-8999-999999999999"
},
"type": "to_do"
}
],
"next_cursor": null,
"has_more": false
}
行为说明或限制
children使用 block input 结构,字段格式与页面创建时一致。after可选;不传时会追加到末尾,传入时会插到指定子块之后。children至多 100 个,且必须至少有 1 个。- 仅支持可写的 block 类型;不支持的类型会被拒绝。
错误提示
400 validation_error:children为空、超过上限,或after不是当前 block 的直接子块。400 unsupported_block_type:传入了不支持写入的 block 类型。401 unauthorized:token 无效或已过期。403 forbidden:缺少blocks.write或无权访问父 block。404 not_found:父 block 不存在。
