deletes_user_group
Permanently delete a specific user group from your LearnWorlds school by its unique ID. Use only after user confirmation, as this action cannot be undone.
Instructions
๐ด DESTRUCTIVE ยท deletes ยท DELETE /v2/user_groups/{id}
Deletes a specific user group asynchronously. This endpoint removes a user group identified by its unique ID. The deletion request is processed asynchronously, meaning the operation may continue after the initial request is accepted.
Behavior: permanently removes the addressed record from the live school โ no undo from this server. Auth (admin API token + Lw-Client id) is injected server-side, never by the model; calls are throttled to stay under LearnWorlds' 30-per-10s cap and retried on 429/5xx.
Returns: HTTP 200/204, with a body that is usually empty on success. A non-2xx reply surfaces as a tool error with that status and the API error payload โ 401 bad/expired token, 403 not permitted, 404 no such record, 422 rejected input.
Use when: only after the user confirms the removal. To merely revoke access or deactivate, use the matching ๐ก update or unenroll tool instead. Related User groups tools: add_user_user_group, get_user_group, get_users_user_group, remove_user_user_group, update_user_group.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The unique identifier of the user group |