Skip to content

修改邮箱联系人信息

修改一个邮箱联系人的信息

Tip: 使用 tenant_access_token 时,需要申请邮箱联系人资源的数据权限。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/mail/v1/user_mailboxes/:user_mailbox_id/mail_contacts/:mail_contact_id
HTTP MethodPATCH
接口频率限制20 次/分钟
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用mail:user_mailbox.mail_contact: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"
mail_contact_idstring邮箱联系人 id,获取方式见 列出邮箱联系人
示例值:"123"

请求体

名称类型必填描述
namestring联系人姓名
示例值:"张三"
数据校验规则
- 长度范围:164 字符
companystring联系人公司
示例值:"张三科技有限公司"
数据校验规则
- 最大长度:64 字符
phonestring联系人手机号
示例值:"19912341234"
数据校验规则
- 最大长度:40 字符
mail_addressstring联系人邮箱
示例值:"zhangsan@example.com"
数据校验规则
- 最大长度:319 字符
tagstring联系人标签
示例值:"朋友"
数据校验规则
- 最大长度:64 字符
remarkstring联系人备注
示例值:"飞书发布会认识"
数据校验规则
- 最大长度:1000 字符
positionstring联系人职位
示例值:"CEO"
数据校验规则
- 最大长度:64 字符

请求体示例

json
{
    "name": "张三",
    "company": "张三科技有限公司",
    "phone": "19912341234",
    "mail_address": "zhangsan@example.com",
    "tag": "朋友",
    "remark": "飞书发布会认识",
    "position": "CEO"
}

响应

响应体

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

响应体示例

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

错误码

HTTP状态码错误码描述排查建议
4001230001参数错误修改参数后重试
5001230003内部错误请稍后重试
4031230002无权限成为公共邮箱成员或申请相关数据权限后调用该接口

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