SDKsuni-app

Update group profile

OpenIM uni-app / uni-app x SDK guide for Update group profile.

Use setGroupInfo() to update basic group profile fields. Pass only the values that actually changed.

Parameters

Parameter	Type	Required	Description
`groupID`	`string`	Yes	Group to update.
`groupName`	`string` or `null`	No	New group name.
`introduction`	`string` or `null`	No	New introduction.
`faceURL`	`string` or `null`	No	New avatar URL.

Provide at least one actual profile field besides groupID; omitted fields retain their values.

import { setGroupInfo } from '@/uni_modules/unix-openim-sdk'

await setGroupInfo({
  groupID,
  groupName: groupName.trim(),
  introduction: introduction.trim(),
  faceURL,
})

Do not mix announcement, join-verification, or member-permission fields into the ordinary profile-save flow; editing a name must not overwrite unrelated settings. The server enforces owner/admin permission.

Promise success means that OpenIMServer completed the request. Merge onGroupInfoChanged by groupID or call getSpecifiedGroupsInfo() for immediate reconciliation. Do not overwrite fields that were not submitted.

displayIsRead is an Enterprise field. Do not send it when the public server or installed edition does not expose the capability.

Was this page helpful?