服务端 API/云文档/文档/块/删除块
# 删除块

指定需要操作的块，删除其指定范围的子块。如果操作成功，接口将返回应用删除操作后的文档版本号。

**注意事项**：**应用频率限制**：单个应用调用频率上限为每秒 3 次，超过该频率限制，接口将返回 HTTP 状态码 400 及错误码 99991400；

**文档频率限制**：单篇文档并发编辑上限为每秒 3 次，超过该频率限制，接口将返回 HTTP 状态码 429，编辑操作包括：
- 创建块
- 删除块
- 更新块
- 批量更新块

当请求被限频，应用需要处理限频状态码，并使用指数退避算法或其它一些频控策略降低对 API 的调用速率。

## 请求

基本 | &nbsp;
---|---
HTTP URL | https://open.larksuite.com/open-apis/docx/v1/documents/:document_id/blocks/:block_id/children/batch_delete
HTTP Method | DELETE
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 创建及编辑新版文档(docx:document)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>或<br>`user_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"

### 路径参数

名称 | 类型 | 描述
---|---|---
document_id | string | 文档的唯一标识。对应新版文档 Token，[点击了解如何获取云文档 Token](https://open.larksuite.com/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#08bb5df6)。<br>**示例值**："doxcnePuYufKa49ISjhD8Ih0ikh"
block_id | string | 父 Block 的唯一标识<br>**示例值**："doxcnO6UW6wAw2qIcYf4hZpFIth"

### 查询参数

名称 | 类型 | 必填 | 描述
---|---|---|---
document_revision_id | int | 否 | 操作的文档版本，-1 表示文档最新版本。编辑文档需要持有文档的编辑权限。<br>**示例值**：-1<br>**默认值**：`-1`<br>**数据校验规则**：<br>- 最小值：`-1`
client_token | string | 否 | 操作的唯一标识，与接口返回值的 client_token 相对应，用于幂等的进行更新操作。此值为空表示将发起一次新的请求，此值非空表示幂等的进行更新操作。<br>**示例值**："fe599b60-450f-46ff-b2ef-9f6675625b97"

### 请求体

名称 | 类型 | 必填 | 描述
---|---|---|---
start_index | int | 是 | 删除的起始索引（操作区间左闭右开）<br>**示例值**：0<br>**数据校验规则**：<br>- 最小值：`0`
end_index | int | 是 | 删除的末尾索引（操作区间左闭右开）<br>**示例值**：1<br>**数据校验规则**：<br>- 最小值：`1`

### 请求体示例
```json
{
    "start_index": 0,
    "end_index": 1
}
```

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
document_revision_id | int | 当前删除操作成功后文档的版本号
client_token | string | 操作的唯一标识，更新请求中使用此值表示幂等的进行此次更新

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "document_revision_id": 1,
        "client_token": "fe599b60-450f-46ff-b2ef-9f6675625b97"
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 1770001 | invalid param | 确认传入的参数是否合法
404 | 1770002 | not found | 确认文档是否已被删除
400 | 1770003 | resource deleted | 确认资源是否已被删除
400 | 1770004 | too many blocks in document | 确认文档 Block 数量是否超上限
400 | 1770005 | too deep level in document | 确认文档 Block 层级是否超上限
400 | 1770006 | schema mismatch | 确认文档结构是否合法
400 | 1770007 | too many children in block | 确认指定 Block 的 Children 数量是否超上限
400 | 1770008 | too big file size | 确认上传的文件尺寸是否超上限
400 | 1770010 | too many table column | 确认表格列数是否超上限
400 | 1770011 | too many table cell | 确认表格单元格数量是否超上限
400 | 1770012 | too many grid column | 确认 Grid 列数量是否超上限
400 | 1770013 | relation mismatch | 确认图片、文件等资源的关联关系是否正确，插入图片、文件需先上传素材
400 | 1770014 | parent children relation mismatch | 确认 Block 父子关系是否正确
400 | 1770015 | single edit with multi document | 确认 Block 所属文档与指定的 Document 是否相同
400 | 1770019 | repeated blockID in document | 确认 Document 中的 BlockID 是否有重复
400 | 1770020 | operation denied on copying document | 确认 Document 是否正在创建副本中
400 | 1770021 | too old document | 确认指定的 Document 版本过旧
400 | 1770022 | invalid page token | 确认查询参数中的 page_token 是否合法
400 | 1770024 | invalid operation | 确认操作是否合法
400 | 1770025 | operation and block not match | 确认指定 Block 应用对应操作是否合法
400 | 1770026 | row operation over range | 确认行操作下标是否越界
400 | 1770027 | column operation over range | 确认列操作下标是否越界
400 | 1770028 | block not support create children | 确认指定 Block 添加 Children 是否合法
400 | 1770029 | block not support to create | 确认指定 Block 是否支持创建
400 | 1770030 | invalid parent children relation | 确认指定操作其父子关系是否合法
400 | 1770031 | block not support to delete children | 确认指定 Block 是否支持删除 Children
400 | 1770033 | raw content size exceed limited | 纯文本内容大小超过限制
400 | 1770034 | operation count exceed limited | 当前请求中涉及单元格个数过多，请拆分成多次请求
403 | 1770032 | forbidden | 1. 确认操作者是否有该文档的权限。[点击了解什么是文档权限](https://open.larksuite.com/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#2431c595)<br>2. 确认操作者是否有被 mention 的文档的阅读权限。<br>3. 确认 mention 的用户是否在职且与当前操作者互为联系人。<br>4. 确认操作者是否具有群卡片的查看和分享权限。<br>5. 确认操作者是否具有访问指定的 Wiki 子目录的权限。<br>6. 确认操作者是否具有 OKR、ISV、Add-Ons 的查询权限。
500 | 1771001 | server internal error | 服务器内部错误
500 | 1771006 | mount folder failed | 挂载文档到云空间目录失败
500 | 1771002 | gateway server internal error | 网关服务内部错误
500 | 1771003 | gateway marshal error | 网关服务解析错误
500 | 1771004 | gateway unmarshal error | 网关服务反解析错误
503 | 1771005 | system under maintenance | 系统服务正在维护中

