跳到主要内容

修改好友信息

简要描述

  • 修改指定用户(ownerUserID)的某个好友(friendUserID)的备注、星标信息。仅传需要修改的字段,也支持零值。

请求方式

  • post

请求 URL

  • {API_ADDRESS}/friend/update_friends
header 名示例值选填类型说明
operationID1646445464564必填string用于全局链路追踪,建议使用时间戳,在每个请求中独立
tokeneyJhbxxxx3Xs必填string管理员 token

请求参数示例

{
"ownerUserID": "11111111",
"friendUserIDs": ["1112"],
"remark": "remark",
"isPinned": true,
"ex": "ex"
}
字段名选填类型说明
ownerUserID必填string为该用户的好友设置字段
friendUserID必填string需要设置字段的好友
remark选填string备注内容
isPinned选填boolean是否星标
ex选填string扩展字段

成功返回示例

{
"errCode": 0,
"errMsg": "",
"errDlt": ""
}

成功返回示例的参数说明

参数名类型说明
errCodeint错误码,0 表示成功
errMsgstring错误简要信息,为空
errDlterrDlt错误详细信息,为空

失败返回示例

{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}

失败返回示例的参数说明

参数名类型说明
errCodeint错误码,具体查看全局错误码文档
errMsgstring错误简要信息
errDlterrDlt错误详细信息