Dismiss Group
Brief Description
- Dismisses a group. Once dismissed, the group cannot be restored.
Request Method
post
Request URL
{API_ADDRESS}/group/dismiss_group
Header
| Header Name | Example Value | Optional | Type | Description |
|---|---|---|---|---|
| operationID | 1646445464564 | Required | string | Used for global trace tracking. It is recommended to use a timestamp, unique for each request |
| token | eyJhbxxxx3Xs | Required | string | Admin token |
Request Parameters Example
{
"groupID": "2137448827",
"deleteMember": true
}
| Field Name | Optional | Type | Description |
|---|---|---|---|
| groupID | Required | string | Group ID |
| deleteMember | Optional | boolean | Whether to delete group member information |
Success Response Example
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": null
}
Success Response Parameters Description
| Parameter Name | Type | Description |
|---|---|---|
| errCode | int | Error code, 0 indicates success |
| errMsg | string | Brief error message, empty if none |
| errDlt | errDlt | Detailed error information, empty if none |
| data | object | General data object, see structure below |
Failure Response Example
{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}
Failure Response Parameters Description
| Parameter Name | Type | Description |
|---|---|---|
| errCode | int | Error code, refer to global error code documentation |
| errMsg | string | Brief error message |
| errDlt | errDlt | Detailed error information |