Platform API

Set group member info

Use Set group member info to update nicknames, avatars, roles, or extension fields for up to 1,000 group members.

HTTP request

POST {API_ADDRESS}/group/set_group_member_info

Request example

curl --request POST "${API_ADDRESS}/group/set_group_member_info" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${ADMIN_TOKEN}" \
  --data-raw '{
  "members": [
    {
      "groupID": "group_001",
      "userID": "user_002",
      "nickname": "Alice",
      "faceURL": "https://example.com/new-avatar.png",
      "roleLevel": 60,
      "ex": ""
    }
  ]
}'

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

Request body

{
  "members": [
    {
      "groupID": "group_001",
      "userID": "user_002",
      "nickname": "Alice",
      "faceURL": "https://example.com/new-avatar.png",
      "roleLevel": 60,
      "ex": ""
    }
  ]
}

Parameter	Required	Type	Description
members	Yes	array	Member updates following `GroupMemberInfo`, up to 1,000 items.
members.groupID	Yes	string	OpenIM group ID.
members.userID	Yes	string	OpenIM user ID.
members.nickname	No	string	User nickname.
members.faceURL	No	string	Avatar or icon URL.
members.roleLevel	No	int	Member role. See `GroupMemberRole`. This endpoint accepts administrator (`60`) or regular member (`20`), not owner.
members.ex	No	string	Business extension field.

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

Do not use this endpoint to assign the owner role. Use Transfer group owner.
A successful request updates member data and may produce member-info change notifications.

Was this page helpful?