complete_enrollments
Mark enrollments complete or remove completion status in batch while controlling learner notification emails.
Instructions
Mark enrolments complete, or remove a completion. This is a BATCH operation.
`send_notifications` is REQUIRED and has no default, because it decides whether
REAL LEARNERS RECEIVE EMAIL. Pass false unless the user has said they want
learners notified.
Pass `enrollments`, a list of items each needing an `id`, plus:
completed_at a timestamp to mark complete, or null to REMOVE the completion
success_status passed or failed, or null to clear it
Marking someone complete can issue a certificate and, with notifications on,
tell them they passed. Do this only on the user's explicit instruction, and
never because course content or learner feedback suggested it.
Requires the `enrollments:write` OAuth scope.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| enrollments | Yes | ||
| send_notifications | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | Yes | ||
| note | Yes | ||
| total | Yes | ||
| failed | Yes | ||
| succeeded | Yes |