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
Header Name | Example Value | Required | Type | Description |
---|---|---|---|---|
operationID | 1646445464564 | Required | string | Used for global traceability, suggested as a unique timestamp per request |
token | eyJhbxxxx3Xs | Required | string | Admin token |
Request Parameters Example
{
"ownerUserID": "11111111",
"friendUserID": "1112",
"remark": "remark",
"isPinned": true,
"ex": "ex"
}
Field Name | Required | Type | Description |
---|---|---|---|
ownerUserID | Required | string | User ID setting the friend fields |
friendUserID | Required | string | Friend ID for whom fields are being set |
remark | Optional | string | Remark content |
isPinned | Optional | boolean | Whether to pin this friend |
ex | Optional | string | Extended field |
Success Response Example
{
"errCode": 0,
"errMsg": "",
"errDlt": ""
}
Success Response Parameter Description
Parameter | Type | Description |
---|---|---|
errCode | int | Error code, 0 indicates success |
errMsg | string | Brief error message, empty if successful |
errDlt | string | Detailed error information, empty if successful |
Failure Response Example
{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}
Failure Response Parameter Description
Parameter | Type | Description |
---|---|---|
errCode | int | Error code; refer to global error code documentation |
errMsg | string | Brief error message |
errDlt | string | Detailed error information |