Call the deletePersonFromGroup operation to remove an individual from one or more individual groups.
QPS limit
10 calls per second per account. Exceeding this limit triggers throttling.
Request syntax
POST /green/sface/person/groups/delete HTTPS|HTTPRequest headers
This operation uses only common request headers. For more information, see Common request headers.
Request parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| clientInfo | JSONObject | No | {"userId":"120234234","userNick":"Mike","userType":"others"} | The client information serialized from the ClientInfo structure in JSON format. Includes the unique machine identifier (UMID) and International Mobile Equipment Identity (IMEI) of the client. For more information, see ClientInfo. |
RequestBody
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| personId | String | Yes | person1 | The ID of the individual to remove. |
| groupIds | StringArray | Yes | ["group1","group2"] | The individual group IDs to remove the individual from. |
Response elements
All responses are returned in JSON format. For common response parameters, see Common response parameters.
The data field contains the following parameters. This field may be empty if an error occurs.
| Parameter | Type | Example | Description |
|---|---|---|---|
| code | Integer | 200 | The HTTP status code. For more information, see Common error codes. |
| personId | String | person1 | The ID of the individual. |
| groupIds | StringArray | ["group1","group2"] | The individual groups from which the individual was removed. |
Examples
Sample request
POST /green/sface/person/groups/delete HTTP/1.1
Common request headers
{
"personId": "person1",
"groupIds": [
"group1",
"group2"
]
}Sample success response
{
"msg": "OK",
"code": 200,
"requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
"data": {
"code": 200,
"personId": "person1",
"groupIds": [
"group1",
"group2"
]
}
}Error codes
For a list of error codes, see Service error codes.