Platform API

Update a user

Use Update a user to change selected profile fields for an existing OpenIM user. In addition to userID, send only the fields that must change; omitted fields remain unchanged.

HTTP request

POST {API_ADDRESS}/user/update_user_info_ex

Request example

curl --request POST "${API_ADDRESS}/user/update_user_info_ex" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${ADMIN_TOKEN}" \
  --data-raw '{
  "userInfo": {
    "userID": "2",
    "nickname": "alantestuid3",
    "faceURL": "",
    "ex": "123",
    "globalRecvMsgOpt": 0
  }
}'

Keep administrator tokens on trusted backend services only. Client applications should use user tokens issued by your backend.

Request body

{
  "userInfo": {
    "userID": "2",
    "nickname": "alantestuid3",
    "faceURL": "",
    "ex": "123",
    "globalRecvMsgOpt": 0
  }
}

Parameter	Required	Type	Description
userInfo	Yes	object	Partial user profile update. Omitted fields are not changed.
userInfo.userID	Yes	string	User to update.
userInfo.nickname	No	string	New nickname. An explicit empty string clears the value.
userInfo.faceURL	No	string	New avatar URL. An explicit empty string clears the value.
userInfo.ex	No	string	New business extension value. An explicit empty string clears the value.
userInfo.globalRecvMsgOpt	No	int	Global message receiving option. See `GlobalRecvMsgOpt`.
userInfo.addFriendPermission Enterprise	No	int	Friend request permission. See `AddFriendPermission`.

Response

OpenIM usually returns 200 OK when the request reaches the service. Use errCode in the JSON response to determine business success; errCode === 0 means the operation succeeded.

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

Response fields

Field	Type	Description
errCode	int	Business error code. `0` means success.
errMsg	string	Short error message.
errDlt	string	Detailed error information for troubleshooting.

Error response

When a request fails, OpenIM returns the same error envelope. See Error codes for the full handling model.

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

Scenario	Possible cause	Recommended action
Authentication failed	`token` is missing, expired, or not an administrator token.	Issue a new administrator token and keep it on the backend.
Traceability is weak	`operationID` is missing or reused across many requests.	Generate a unique `operationID` for every request and log it with the response.
Validation failed	The request body has an invalid type, missing field, or unsupported enum value.	Compare the payload with the request table and retry after correcting the fields.

Permissions and limits

Omitted optional fields remain unchanged; an explicitly supplied empty string clears a string field.
addFriendPermission is available in OpenIM Enterprise.

Was this page helpful?