Platform API

Update a notification account

Use Update a notification account to change its nickname or avatar. In addition to userID, provide at least one of nickName and faceURL.

HTTP request

POST {API_ADDRESS}/user/update_notification_account

Request example

curl --request POST "${API_ADDRESS}/user/update_notification_account" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${ADMIN_TOKEN}" \
  --data-raw '{
  "userID": "notice_001",
  "nickName": "Alice",
  "faceURL": "https://cdn.example.com/avatar/notice-new.png"
}'

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

Request body

{
  "userID": "notice_001",
  "nickName": "Alice",
  "faceURL": "https://cdn.example.com/avatar/notice-new.png"
}

Parameter	Required	Type	Description
userID	Yes	string	Notification account to update.
nickName	Conditional	string	New display name. At least one of `nickName` and `faceURL` is required.
faceURL	Conditional	string	New avatar URL. At least one of `nickName` and `faceURL` is required.

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": "",
  "data": {}
}

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.
data	object	Endpoint-specific response data.

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

Validate backend operator permissions before changing notification account presentation.
Use Search notification accounts to confirm the account exists.

Was this page helpful?