update_enrollments
Update existing enrollments in batch to activate or deactivate learner access, and set or clear due and expiration dates.
Instructions
Change access on existing enrolments. This is a BATCH operation.
Pass `enrollments`, a list of items each needing an `id`. Writable fields:
active true reactivates, false deactivates. NULL IS INVALID - omit the
field entirely to leave it unchanged.
due_at a timestamp, or null to CLEAR it
expires_at a timestamp, or null to CLEAR it
Note the asymmetry: null clears `due_at` and `expires_at` but is rejected for
`active`. Deactivating removes a learner's access to the course.
Requires the `enrollments:write` OAuth scope.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| enrollments | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | Yes | ||
| note | Yes | ||
| total | Yes | ||
| failed | Yes | ||
| succeeded | Yes |