删除保护范围
根据保护范围 ID 删除保护范围。
注意事项
单次调用该接口,最多支持删除 10 个保护范围。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/sheets/v2/spreadsheets/:spreadsheetToken/protected_range_batch_del |
| HTTP Method | DELETE |
| 接口频率限制 | 100 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | drive:drive 查看、评论、编辑和管理云空间中所有文件 sheets:spreadsheet 查看、评论、编辑和管理电子表格 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | 应用调用 API 时,需要通过访问凭证(access_token)进行身份鉴权,参考选择并获取访问凭证。 值格式:"Bearer access_token" 可选值如下: - tenant_access_token: 以应用身份调用 API,可读写的数据范围由应用自身的数据权限范围决定。参考自建应用获取 tenant_access_token或商店应用获取 tenant_access_token。示例值:"Bearer t-g1044qeGEDXTB6NDJOGV4JQCYDGHRBARFTGT1234" - user_access_token: 以用户身份调用 API,可读写的数据范围由用户的的数据权限范围决定。参考获取 user_access_token。示例值:"Bearer u-cjz1eKCEx289x1TXEiQJqAh5171B4gDHPq00l0GE1234" |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
| spreadsheetToken | string | 电子表格的 token。可通过以下两种方式获取。了解更多,参考电子表格概述。 - 电子表格的 URL:https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== - 调用获取文件夹中的文件清单 示例值:"Iow7sNNEphp3WbtnbCscPqabcef" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
protectIds | array<string> | 是 | 要删除的保护范围 ID,可通过获取表格元数据 获取。最多支持传入 10 个保护范围 ID。 |
请求体示例
json
{
"protectIds": ["6947942538267541505"]
}cURL 请求示例
bash
curl --location --request DELETE 'https://open.feishu.cn/open-apis/sheets/v2/spreadsheets/shtcngNygNfuqhxTBf588jwgWbJ/protected_range_batch_del' \
--header 'Authorization: Bearer t-e346617a4acfc3a11d4ed24dca0d0c0fc8e0067e' \
--header 'Content-Type: application/json' \
--data-raw '{
"protectIds": ["6947942538267541505","6946456074476339204"]
}'响应
响应体
| 参数 | 类型 | 说明 |
|---|---|---|
delProtectIds | array<string> | 成功删除的保护范围 ID |
响应体示例
json
{
"code": 0,
"msg": "Success",
"data": {
"delProtectIds": [
"6947942538267541505"
]
}
}错误码
具体可参考:服务端错误码说明
