deactivate_student
Deactivate a learner's account in Skilljar to revoke access without deleting records. This reversible action retains data and enrollments, allowing you to restore the learner later.
Instructions
Deactivate a learner's account, removing their access. This is REVERSIBLE.
`id` is the obfuscated Skilljar learner id. A soft delete: the record and its
history remain, and the account can be reactivated with `update_students` and
`is_inactive: false`. Their enrolments are
NOT removed.
Prefer this over `anonymize_student` whenever the goal is to stop someone using
the platform, because this one can be undone.
Requires the `students:deactivate` OAuth scope AND the `people.destructive`
capability.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| note | Yes | ||
| deactivated | Yes |