/api/public/v1/groups/{id}/deletegroups.delete
Delete a group: move its profiles (and member access) to another group, or leave them ungrouped only when you say so.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
idpath | string (uuid) | Yes | Group id |
command_idbody | string (uuid) | Yes | Client-generated UUID for this command. Send the same id (and body) again to get the stored receipt instead of a second change; a different body under the same id is CONFLICT. |
expected_revisionbody | integer | Yes | The revision you last read; a newer revision on the server is CONFLICT (min 1, max 9007199254740991) |
move_tobody | string (uuid) | null | No | Group that receives this group's profiles and member access Default: `null`. |
allow_ungroupedbody | boolean | No | true to leave the profiles without a group when move_to is null; otherwise a non-empty group is refused with CONFLICT Default: `false`. |
Examples
curl -X POST "https://browlix.com/api/public/v1/groups/<id>/delete" \
-H "Authorization: Bearer $BROWLIX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"command_id":"<uuid>","expected_revision":1}'Response
201 with { data, replayed: false, correlation_id } the first time; 200 with replayed: true when the same command_id and body come again.
| Field | Type | Always present | Description |
|---|---|---|---|
| data | object | Yes | |
| data.group_id | string (uuid) | Yes | |
| data.moved_profiles | integer | Yes | (min -9007199254740991, max 9007199254740991) |
| data.moved_to | string (uuid) | null | Yes | |
| correlation_id | string (uuid) | Yes | |
| replayed | boolean | No | true when this command_id was already applied and the stored receipt came back |
Errors
| Code | HTTP | Retryable |
|---|---|---|
| UNAUTHENTICATED | 401 | No |
| FORBIDDEN | 403 | No |
| RATE_LIMITED | 429 | Yes |
| VALIDATION_FAILED | 422 | No |
| NOT_FOUND | 404 | No |
| CONFLICT | 409 | No |
| OUTCOME_UNKNOWN | 202 | Yes |
| DEPENDENCY_UNAVAILABLE | 503 | Yes |
| UNKNOWN | 500 | No |