update_students
Batch update learner names or active state in Skilljar. Identify each student by ID or email; deactivating preserves enrolments. Reactivation requires two separate calls.
Instructions
Change a learner's name or active state. This is a BATCH operation.
Identify each item by `id` (preferred) OR by `email`; at least one is required.
`email` is READ-ONLY and behaves differently depending on what else you send:
with no `id` it identifies which learner to change, and is not itself changed
with an `id` it acts as a CONFIRMATION - if the id belongs to someone else the
row fails rather than writing to the wrong person
Passing both is the safe form when you are acting on a learner you looked up
earlier.
Writable: `first_name`, `last_name` (max 50), and `is_inactive`. Deactivating
here does NOT touch the learner's enrolments.
REACTIVATING TAKES TWO SEPARATE CALLS. Setting `is_inactive: false` together
with other fields is refused, because Skilljar accepts it and silently drops the
other fields. Send `{is_inactive: false}` first, then the rest.
Requires the `students:write` OAuth scope.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| students | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | Yes | ||
| note | Yes | ||
| total | Yes | ||
| failed | Yes | ||
| succeeded | Yes |