移除清单成员

移除清单的一个或多个协作成员。通过设置members字段表示要移除的成员信息。关于member的格式，详见功能概述中的“ 如何表示任务和清单的成员？”章节。

清单中同一个成员只能有一个角色，通过的member的id和type可以唯一确定一个成员，因此请求参数中对于要删除的成员，不需要填写"role"字段。

如果要移除的成员不在清单中，则被自动忽略，接口返回成功。

该接口不能用于移除清单所有者。如果要移除的成员是清单所有者，则会被自动忽略。如要设置清单所有者，需要调用更新清单接口。

Tip: 需要清单编辑权限。详情见清单功能概述中的“清单是如何鉴权的？“章节。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/task/v2/tasklists/:tasklist_guid/remove_members
HTTP Method	POST
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	task:tasklist:write 查看、创建、更新、删除任务清单

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

路径参数

名称	类型	描述
tasklist_guid	string	要移除协作人的清单全局唯一ID 示例值："d300a75f-c56a-4be9-80d1-e47653028ceb" 数据校验规则： - 最大长度：100 字符

查询参数

名称	类型	必填	描述
user_id_type	string	否	用户 ID 类型 示例值：open_id 默认值：open_id

请求体

名称	类型	必填	描述
members	member\[\]	是	要移除的member列表。关于member的格式，详见功能概述中的“ 如何表示任务和清单的成员？”章节。 数据校验规则： - 长度范围：1 ～ 500
└ id	string	否	表示member的id 示例值："ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f" 数据校验规则： - 最大长度：100 字符
└ type	string	否	成员的类型，支持： - user: 普通用户，此时member的id是一个表示用户的ID，比如open_id。具体格式取决于user_id_type参数 - chat: 群组，此时member的id是一个Open Chat ID - app: 应用，此时member的id是一个应用的ID 示例值："user" 默认值：user
└ role	string	否	清单角色。移除清单成员时该字段不需要填写。 示例值："editor" 数据校验规则： - 最大长度：20 字符

请求体示例

{
    "members": [
        {
            "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
            "type": "user",
            "role": "editor"
        }
    ]
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ tasklist	tasklist	修改完成后的清单实体
└ guid	string	清单的全局唯一ID
└ name	string	清单名
└ creator	member	清单创建者
└ id	string	表示member的id
└ type	string	成员类型
└ role	string	成员角色
└ owner	member	清单所有者
└ id	string	表示member的id
└ type	string	成员类型
└ role	string	成员角色
└ members	member\[\]	清单协作成员列表
└ id	string	表示member的id
└ type	string	成员类型
└ role	string	成员角色
└ url	string	该清单分享的applink
└ created_at	string	清单创建时间戳(ms)
└ updated_at	string	清单最后一次更新时间戳（ms)

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "tasklist": {
            "guid": "cc371766-6584-cf50-a222-c22cd9055004",
            "name": "年会总结工作任务清单",
            "creator": {
                "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                "type": "user",
                "role": "creator"
            },
            "owner": {
                "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                "type": "user",
                "role": "owner"
            },
            "members": [
                {
                    "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                    "type": "user",
                    "role": "editor"
                }
            ],
            "url": "https://applink.feishu.cn/client/todo/task_list?guid=b45b360f-1961-4058-b338-7f50c96e1b52",
            "created_at": "1675742789470",
            "updated_at": "1675742789470"
        }
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1470400	请求参数错误，如提供的清单GUID不合法。	错误原因见返回的msg提示的信息。
404	1470404	清单不存在或已删除。	确认要移除成员的清单是否还存在。
500	1470500	服务器错误。	尝试重试调用。如持续失败，请联系支持人员进行反馈。
403	1470403	缺少清单编辑权限。	检查调用身份拥有清单的编辑权限。详情见清单功能概述中的“清单是如何鉴权的？“章节。