Browse SDKs · WASM
SDKsWASMEnterprise

Update a conversation group

Update a conversation group’s name, extension data, or hidden state.

Copy

Use updateConversationGroup() to modify an existing conversation group. conversationGroupID selects the group; pass only the fields that need to change.

Parameters

ParameterTypeRequiredDescription
conversationGroupIDstringYesConversation group ID to update.
namestringNoNew group name.
exstringNoNew application extension string.
hiddenbooleanNoWhether to hide the group.
const { data: group } = await openimsdk.updateConversationGroup({
  conversationGroupID,
  name: 'Priority work',
  hidden: false,
});

Return result

After the Promise succeeds, data is the updated ConversationGroup. Use conversationGroupID to find and replace the matching group. See Get conversation groups for complete fields.

After the update request completes, another signed-in client or later synchronization may receive OnConversationGroupChanged. See Conversation group overview for the complete listener and how to update the group list.