OpenIMDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse Platform API
Platform APIEnterprise

Remove conversations from groups

Copy

Remove selected conversations from one or more conversation groups owned by the same user.

HTTP request

POST {API_ADDRESS}/conversation/remove_conversations_from_groups

Request example

curl --request POST "${API_ADDRESS}/conversation/remove_conversations_from_groups" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" --header "token: ${TOKEN}" \
  --data-raw '{"ownerUserID":"user_001","conversationIDs":["si_user_001_user_002"],"conversationGroupIDs":["conversation_group_001"]}'

Request body

ParameterRequiredTypeDescription
ownerUserIDYesstringUser who owns the conversations and groups.
conversationIDsYesstring[]Conversation IDs to remove.
conversationGroupIDsYesstring[]Source group IDs.

Response

The common response has errCode: 0 when the memberships were updated successfully.

Errors

See Error codes.

Permissions and limits

  • Available only in OpenIM Enterprise.
  • Removing a conversation from a group does not delete the conversation.