remove_group_memberships
Batch remove learners from a student group. Revokes course access when the group carries a visibility override, while enrollments and progress remain untouched.
Instructions
Remove learners from a student group. This is a BATCH operation.
`id` is the group. `student_ids` are obfuscated learner ids.
IDEMPOTENT: removing someone who was never a member reports `deleted` just like
removing a real member. There is no "not a member" outcome on the wire, so this
call cannot be used to find out who was in the group.
Removing a learner can REVOKE COURSE ACCESS they currently have, if the group
carried a visibility override. Their enrollments and progress are untouched.
Requires the `student-groups:write` OAuth scope.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| student_ids | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | Yes | ||
| total | Yes | ||
| failed | Yes | ||
| group_id | Yes | ||
| succeeded | Yes | ||
| student_ids | Yes |