Delete user groups

Delete user groups from a community channel.

• Deleting a user group automatically removes all member relationships.
• Deleting a user group automatically removes all subchannel bindings.
• Former members of the deleted user group receive a notification via client callback.

Request method

POST: https://Base URL/v4/community-channel/user-group/delete

Rate limit: 100 requests per second

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

Request body

The request body is in application/json format and supports the following parameters:

Parameter	Type	Required	Description
channelId	String	Yes	The community channel ID. Must already exist.
userGroupIds	Array	Yes	List of user group IDs to delete. Maximum 10 per request; the entire request fails if exceeded.

Request example

HTTP

POST /v4/community-channel/user-group/delete HTTP/1.1
Host: api.sg-light-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json

{
    "channelId": "abc",
    "userGroupIds": ["roleId1", "roleId2"]
}

Response

Field	Type	Description
code	Number	Status code. 0 indicates success.

Response example

HTTP

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

{"code":0}