Platform API

Set group info extension

Use Set group info extension to update group profile fields with a flat request body. This endpoint is suitable when a field must be explicitly set to its zero value.

HTTP request

POST {API_ADDRESS}/group/set_group_info_ex

Request example

curl --request POST "${API_ADDRESS}/group/set_group_info_ex" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${ADMIN_TOKEN}" \
  --data-raw '{
  "groupID": "group_001",
  "groupName": "Product Discussion",
  "notification": "Welcome to OpenIM",
  "introduction": "Group for product discussions",
  "faceURL": "https://example.com/new-group.png",
  "ex": "new ex",
  "needVerification": 1,
  "lookMemberInfo": 1,
  "applyMemberFriend": 1
}'

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

Request body

{
  "groupID": "group_001",
  "groupName": "Product Discussion",
  "notification": "Welcome to OpenIM",
  "introduction": "Group for product discussions",
  "faceURL": "https://example.com/new-group.png",
  "ex": "new ex",
  "needVerification": 1,
  "lookMemberInfo": 1,
  "applyMemberFriend": 1
}

Parameter	Required	Type	Description
groupID	Yes	string	OpenIM group ID.
groupName	No	string	Group name.
notification	No	string	Group announcement or notification text.
introduction	No	string	Group introduction.
faceURL	No	string	Avatar or icon URL.
ex	No	string	Business extension field.
needVerification	No	int	Join verification policy. See `GroupVerification`.
lookMemberInfo	No	int	Whether members can view group member information.
applyMemberFriend	No	int	Whether members can add each other as friends from the group.
displayIsRead Enterprise	No	boolean	Whether group-message read status is displayed. The current Enterprise endpoint only permits setting this value to `false`.

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

A successful request updates group profile data and may produce group-info change notifications or webhooks.
Because this endpoint accepts explicit zero values, distinguish omitted fields from values that must be cleared.
displayIsRead is available in OpenIM Enterprise and currently can only be set to false here.

Was this page helpful?