Skip to main content

update_friends

Brief Description

  • Modify the fields for a specific friend (friendUserID) of a specified user (ownerUserID).

Request Method

  • post

Request URL

  • {API_ADDRESS}/friend/update_friends
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringoperationID is used for global link tracking
tokeneyJhbxxxx3XsRequiredstringAdministrator token

Request Sample Parameters

{
"ownerUserID": "11111111",
"friendUserIDs": ["11111112"],
"remark": "remark",
"isPinned": true,
"ex":"ex"
}
Field NameOptionalTypeDescription
ownerUserIDRequiredstringSet fields for this user's friend
friendUserIDsRequiredstring[]The friends for whom the field is to be set
remarkOptionalstringRemark content.
isPinnedOptionalbooleanWhether a friend is pinned
exOptionalstringExtension field

Successful Return Sample

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

Successful Return Sample Explanation

Parameter NameTypeDescription
errCodeintError code, 0 indicates success
errMsgstringBrief error message, empty when no error
errDlterrDltDetailed error message, empty when no error
dataobjectGeneral data object, the specific structure is shown below (Note: No data object is provided)

Failed Return Sample

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

Failed Return Sample Explanation

Parameter NameTypeDescription
errCodeintError code, refer to the global error code document
errMsgstringBrief error message
errDlterrDltDetailed error message