Platform API

Quit group

Use Quit group to remove a specified user's membership from a group. If userID is omitted, the server uses the current acting user.

HTTP request

POST {API_ADDRESS}/group/quit_group

Request example

curl --request POST "${API_ADDRESS}/group/quit_group" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${ADMIN_TOKEN}" \
  --data-raw '{
  "groupID": "group_001",
  "userID": "user_001"
}'

Keep administrator tokens on trusted backend services only. Client applications should use user tokens issued by your backend.

Request body

{
  "groupID": "group_001",
  "userID": "user_001"
}

Parameter	Required	Type	Description
groupID	Yes	string	OpenIM group ID.
userID	No	string	OpenIM user ID.
deleteMember Enterprise	No	boolean	Whether to also delete the departing user's group-member data.

Response

OpenIM usually returns 200 OK when the request reaches the service. Use errCode in the JSON response to determine business success; errCode === 0 means the operation succeeded.

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": ""
}

Response fields

Field	Type	Description
errCode	int	Business error code. `0` means success.
errMsg	string	Short error message.
errDlt	string	Detailed error information for troubleshooting.

Error response

When a request fails, OpenIM returns the same error envelope. See Error codes for the full handling model.

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}

Scenario	Possible cause	Recommended action
Authentication failed	`token` is missing, expired, or not an administrator token.	Issue a new administrator token and keep it on the backend.
Traceability is weak	`operationID` is missing or reused across many requests.	Generate a unique `operationID` for every request and log it with the response.
Validation failed	The request body has an invalid type, missing field, or unsupported enum value.	Compare the payload with the request table and retry after correcting the fields.

Permissions and limits

When userID is supplied, OpenIM checks whether the acting user may remove that membership.
A group owner normally must transfer ownership before leaving.

Was this page helpful?