Skip to main content

update_friends

Description

  • Update the remark or pinned status for a specific friend (friendUserID) of a specified user (ownerUserID). Only the fields to be modified need to be provided, including zero values if necessary.

Request Method

  • POST

Request URL

  • {API_ADDRESS}/friend/update_friends
Header NameExample ValueRequiredTypeDescription
operationID1646445464564RequiredstringUsed for global traceability, suggested as a unique timestamp per request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameters Example

{
"ownerUserID": "11111111",
"friendUserID": "1112",
"remark": "remark",
"isPinned": true,
"ex": "ex"
}
Field NameRequiredTypeDescription
ownerUserIDRequiredstringUser ID setting the friend fields
friendUserIDRequiredstringFriend ID for whom fields are being set
remarkOptionalstringRemark content
isPinnedOptionalbooleanWhether to pin this friend
exOptionalstringExtended field

Success Response Example

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

Success Response Parameter Description

ParameterTypeDescription
errCodeintError code, 0 indicates success
errMsgstringBrief error message, empty if successful
errDltstringDetailed error information, empty if successful

Failure Response Example

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

Failure Response Parameter Description

ParameterTypeDescription
errCodeintError code; refer to global error code documentation
errMsgstringBrief error message
errDltstringDetailed error information