更新邮箱信息
更新指定邮箱(当前仅支持公共邮箱)
请求说明
请求地址 | https://openapi.wps.cn/v7/mailboxes/{mailbox_id}/update |
---|---|
请求方法 | POST |
签名方式 | KSO-1 |
权限要求 | 查询和管理邮箱信息(用户授权) kso.mailbox.readwrite |
请求头(Header)
Header 名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
Content-Type | string | 是 | 使用:application/json |
X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
路径参数(Path)
名称 | 参数类型 | 说明 |
---|---|---|
mailbox_id | string | 邮箱 id |
请求体(Body)
名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
name | string | 否 | 名字 |
owner_address | string | 否 | 公共邮箱负责人邮箱地址 |
请求地址示例
[POST] https://openapi.wps.cn/v7/mailboxes/{mailbox_id}/update
请求体示例
json
{
"name": "string",
"owner_address": "string"
}
响应体
名称 | 参数类型 | 说明 |
---|---|---|
code | integer | 响应代码。非 0 表示失败,参照《状态码说明》 |
msg | string | 响应信息 |
data | object | 响应数据 |
∟ address | string | 地址,形如:user_name@domain |
∟ id | string | id |
∟ is_primary | boolean | 是否主邮箱 |
∟ is_shared | boolean | 是否公共邮箱 |
∟ name | string | 名字 |
∟ owner | object | 邮箱负责人 |
∟ ∟ avatar | string | 用户的头像链接 |
∟ ∟ email_address | string | 用户的邮箱地址 |
∟ ∟ name | string | 名字。创建,更新公共邮箱时无需提供 |
more | object | 更多的错误信息 |
响应体示例
json
{
"code": 0,
"data": {
"address": "string",
"id": "string",
"is_primary": false,
"is_shared": false,
"name": "string",
"owner": {
"avatar": "string",
"email_address": "string",
"name": "string"
}
},
"msg": "string"
}