创建公共邮箱

用于进行公共邮箱的创建

请求

基本
HTTP URL	https://hi-gw.weizhipin.com/open-apis/mail/v1/public_mailboxes
HTTP Method	POST
支持的应用类型	自建应用
权限要求	[邮箱]-[创建/更改/查询公共邮箱]

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560"
Content-Type	string	是	固定值："application/json; charset=utf-8"

查询参数（url后?&拼接的参数）

名称	类型	描述
user_id_type	string	用户 ID 类型示例值："open_id" 可选值有： open_id：用户的 open id union_id：用户的 union id user_id：用户的 user id 默认值：open_id 当值为 user_id，字段权限要求： 获取用户 user ID

请求体

名称	类型	必填	描述
email	string	是	邮箱地址：需要带上邮箱后缀,邮箱地址格式错误会报错
name	string	是	邮箱名称
type	int	否	邮箱类型 0：项目 1：系统
principal_user_id	string	是	负责人user_id
explain	int	否	邮箱说明
user_id_list	string[]	否	添加使用人id，当有部分使用人已存在时，仅会添加不存在的使用人 当一个user_id填写错误时，接口整体报错添加失败

请求体示例

{
  "email": "cese01@kanzhun.com",
  "name": "测试公共邮箱",
  "type": 1,
  "principal_user_id": "wh01@kanzhun.com",
  "explain": "测试公共邮箱的说明",
  "user_id_list": ["123"]
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	-	-
∟invalid_user_ids	string[]	不合法的 user_id 列表
trace_id	string	链路id

响应体示例

{
  "code": 0,
  "traceId": "_Ao59UOIBLPCeAAu",
  "success": true,
  "data": {
    "invalid_user_ids":["123"]
  },
  "msg": "操作成功"
}

如果响应非成功状态，请对照 错误码文档