delete_groups
Destructive
Permanently delete student groups in Skilljar. This cascading hard delete removes memberships and course visibility overrides, so learners may lose access to courses. Enrollments survive; no undo.
Instructions
Delete student groups. THIS IS A HARD DELETE AND IT CASCADES.
Unlike quizzes and question banks, a group is not soft-deleted. It is removed
from the database, and everything that points at it goes too:
* every membership - learners are removed from the group
* every published-course visibility override granted through this group, which
means learners can LOSE ACCESS TO COURSES they can currently see
* other link rows referencing the group
The learners themselves are not deleted, and their enrollments survive. What is
lost is the access this group was granting.
`group_ids` takes the obfuscated ids of the groups to destroy; every id is
processed independently and a `failed` entry means that group still exists.
There is no undo. If the intent is to stop using a group while keeping the
option to restore it, rename it and clear its `rule_email_domains` instead.
Requires the `student-groups:write` OAuth scope.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| group_ids | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | Yes | ||
| note | Yes | ||
| total | Yes | ||
| failed | Yes | ||
| succeeded | Yes |