add_visibility_overrides
Grant or deny group access to published courses by batch-adding visibility overrides. Set is_visible true to allowlist or false to blocklist a course for the group.
Instructions
Grant or deny a group access to published courses. This is a BATCH operation.
`id` is the GROUP id. `overrides` is the batch: each item needs
`published_course_id` - the
published-course id, not the course id - and may set `is_visible`:
`is_visible: true` (the DEFAULT) an ALLOWLIST entry: members see the course
even though it is hidden by default
`is_visible: false` a BLOCKLIST entry: members do NOT see the course even
though it is visible by default
THE UNIQUE KEY INCLUDES `is_visible`, so adding true and then false for the same
course creates TWO rows that contradict each other rather than the second
replacing the first. Remove the one you do not want; Skilljar's own guidance is
to keep only one.
Idempotent: re-adding an identical override succeeds and changes nothing, so a
success here does not mean access changed. Duplicates within one batch are
first-wins.
An unknown group is a not-found error whatever else is in the request.
Requires the `student-groups:write` OAuth scope.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| overrides | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | Yes | ||
| note | Yes | ||
| total | Yes | ||
| failed | Yes | ||
| succeeded | Yes |