修改公共邮箱全部信息

更新公共邮箱所有信息。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/mail/v1/public_mailboxes/:public_mailbox_id
HTTP Method	PUT
接口频率限制	特殊频控
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	mail:public_mailbox 查询、创建、修改公共邮箱

请求头

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

路径参数

名称	类型	描述
public_mailbox_id	string	公共邮箱唯一标识或公共邮箱地址 示例值："xxxxxxxxxxxxxxx 或 test_public_mailbox@xxx.xx"

请求体

名称	类型	必填	描述
email	string	否	公共邮箱地址 示例值："test_public_mailbox@xxx.xx"
name	string	否	公共邮箱名称 示例值："test public mailbox"

请求体示例

{
   "name": "xxx",
   "email": "xxx@xxx.xxx"
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	public_mailbox	-
└ public_mailbox_id	string	公共邮箱唯一标识
└ email	string	公共邮箱地址
└ name	string	公共邮箱名称

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "public_mailbox_id": "xxx",
        "email": "xx@xx.xx",
        "name":"xxx"
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
404	1234016	public mailbox not found	请确认公共邮箱是否存在
409	1234033	email address has been used by another member as a login account	邮件地址已被他人用作登录邮箱，请使用其它邮件地址
400	1234008	request parameter error	请检查请求参数是否正确
409	1234006	email address has been used	邮件地址已被占用，请使用其它邮件地址
409	1234023	email address alias exceeds the number limit	超出了邮箱别名限制