Skip to content

修改邮箱文件夹

修改邮箱文件夹

Tip: 使用应用身份访问时,需要申请邮箱文件夹资源的数据权限。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/mail/v1/user_mailboxes/:user_mailbox_id/folders/:folder_id
HTTP MethodPATCH
接口频率限制1 次/秒
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用mail:user_mailbox.folder:write 查看、创建、更新、删除邮箱文件夹

请求头

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

路径参数

名称类型描述
user_mailbox_idstring用户邮箱地址。当使用用户身份访问时,可以输入"me"代表当前调用接口用户
示例值:"user@xxx.xx 或 me"
folder_idstring文件夹 id,id 获取方式见 列出邮箱文件夹
示例值:"7620003644728938013"

请求体

名称类型必填描述
namestring文件夹名字
示例值:"newsletter 相关"
数据校验规则
- 长度范围:1250 字符
parent_folder_idstring父文件夹 id,该值为 0 表示根文件夹,id 获取方式见 列出邮箱文件夹
示例值:"725627422334644"

请求体示例

json
{
    "name": "newsletter 相关",
    "parent_folder_id": "725627422334644"
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {}
}

错误码

HTTP状态码错误码描述排查建议
4001230001invalid param参数错误,请检查请求参数的类型、格式或值是否与接口要求一致,具体可参考接口文档中的参数说明
5001230003internal server error内部服务错误,请稍后重试
4031230002permission denied无权限访问,请确认应用是否具备访问该资源的权限。如使用用户身份访问,请确认具备此用户的访问权限;如使用租户身份访问,请确认已申请对应的数据范围权限。

内容来源:飞书开放平台 · 自动爬取整理