Delete Group
Enterprise
This endpoint is part of Countly Enterprise. To get access, contact sales or compare versions. Existing customers can reach the support portal with questions.
Endpoint
/i/groups/delete
Overview
Deletes a group and removes its membership references from users.
Authentication
Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.
Permissions
- Required access: global admin
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
api_key | String | Yes (or auth_token) | API key authentication |
auth_token | String | Yes (or api_key) | Auth token authentication |
args | Object (JSON string) | Yes | Stringified object containing _id |
args Object Fields
| Field | Type | Required | Description |
|---|---|---|---|
_id | String | Yes | Group ID |
Examples
Example: Delete Group
Endpoint form:
https://your-server.com/i/groups/delete?api_key=YOUR_API_KEY&args={"_id":"507f1f77bcf86cd799439011"}
Decoded args object:
{
"_id": "507f1f77bcf86cd799439011"
}
Response
Success Response
{
"result": "Success"
}
Response Fields
| Field | Type | Description |
|---|---|---|
result | String | Operation status |
Error Responses
| HTTP Status | Response |
|---|---|
| 200 | { "result": "Not enough args" } |
| 400 | { "result": "Missing parameter \"api_key\" or \"auth_token\"" } |
| 400 | Error object from delete path |
Behavior
- Validates
_id. - Deletes group from
countly.groups. - Removes group ID from
countly.members.group_id. - Rebuilds permissions for affected users.
Related Endpoints
Implementation details
Database Collections
| Collection | Used for | Data touched by this endpoint |
|---|---|---|
countly.groups | Endpoint data source | ** - Deleted group record |
countly.members | Endpoint data source | ** - Membership and permission rebuild target |