Skip to main content

Overview​

Sets a custom display name for a friend.

Request​

Authentication: Add authentication headers to the request. See Authentication

Method: POST

Rate limit: 100 requests/second

Endpoint: https://API domain/jim/friends/setdisplayname

Content-Type: application/json

Request Parameters​

ParameterData TypeRequiredDescription
friend_idstringYesFriend user ID.
friend_display_namestringYesCustom display name for the friend.

Request Example​

POST /jim/friends/setdisplayname HTTP/1.1
appkey: appkey
Authorization: xxxxxxxxxxxxxxxxxx
Content-Type: application/json

{
"friend_id":"friend1",
"friend_display_name":"displayname"
}

Response Example​

{
"code":0,
"msg":"sucess"
}