Platform APIEnterprise

Update a conversation group

Update a conversation group's display name, extension data, or hidden state. This endpoint is available only in OpenIM Enterprise.

HTTP request

POST {API_ADDRESS}/conversation/update_conversation_group

Request example

curl --request POST "${API_ADDRESS}/conversation/update_conversation_group" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" --header "token: ${TOKEN}" \
  --data-raw '{"conversationGroupID":"conversation_group_001","ownerUserID":"user_001","name":"Priority","ex":"{}","Hidden":false}'

Request body

Parameter	Required	Type	Description
conversationGroupID	Yes	string	Conversation group ID.
ownerUserID	Yes	string	User who owns the group.
name	No	StringValue	New display name.
ex	No	StringValue	New business extension data.
Hidden	No	BoolValue	Whether the group is hidden. The request field uses this exact capitalization.

Response

data.group contains the updated ConversationGroup.

Errors

See Error codes.

Permissions and limits

Available only in OpenIM Enterprise.
Omit optional wrapper fields that should remain unchanged.

Conversation overview

Was this page helpful?