Skip to main content

Remove from group

This API removes specified users from a group.

Enabling the Service

Before using this feature, you must enable the profile hosting service by submitting a ticket.

Request method

POST: https://data center domain/entrust/group/member/kick.json

Rate limit: 100 requests per second

Signature rules: All server API requests require signature verification. See API request signature.

Request parameters

The HTTP request body uses application/x-www-form-urlencoded format and supports these form parameters:

ParameterTypeRequiredDescription
groupIdStringYesGroup ID
userIdsArrayYesUser IDs to remove (max 100 per request)
isDelBanNumberNoWhether to remove mute status:
  • 0: Keep muted
  • 1: Remove mute (default)
isDelWhiteNumberNoWhether to remove from allowlist:
  • 0: Keep in allowlist
  • 1: Remove from allowlist (default)
isDelFollowedNumberNoWhether to remove from Members I Follow:
  • 0: Keep in list
  • 1: Remove from list (default)

Request example

POST /entrust/group/member/kick.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

groupId=groupId1&userIds=userId&isQuitWhite=0&isDelAttention=1&isQuitBan=0

Response

The HTTP response body contains a JSON object with this structure:

FieldTypeDescription
codeNumberStatus code. 200 indicates success.

Response example

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"code": 200
}