Browse SDKs · WASM
SDKsWASM

Update group profile

Update a group’s basic display profile.

Copy

The group name, introduction, and avatar are basic profile fields shown to members and can be submitted from one profile form. Pass only fields that actually changed.

Parameters

ParameterTypeRequiredDescription
groupIDstringYesGroup ID to update.
groupNamestringNoNew group name.
introductionstringNoNew group introduction.
faceURLstringNoNew group avatar URL.

In addition to groupID, pass at least one profile field to change. Omitted fields retain their previous values.

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

Do not include announcements, join verification, or member permission fields in ordinary profile saves. Otherwise, changing a group name can unintentionally overwrite unrelated settings.

A successful Promise means that OpenIMServer completed the request. Merge group profile changes from OnGroupInfoChanged by groupID; see Group overview for the complete listener. Call getSpecifiedGroupsInfo() when immediate reconciliation is required.