update_groups
Batch update student group fields by ID. Send full email-domain lists because values replace arrays, and use null to clear category.
Instructions
Change student groups. This is a BATCH operation.
Every item needs an `id`. Groups have no stable natural key - names are
renameable, so a name is not durable enough to identify one across calls.
TWO BEHAVIOURS THAT LOSE DATA IF YOU ASSUME THE OPPOSITE:
`rule_email_domains` REPLACES the whole stored array. It does not merge. To add
one domain, send every existing domain plus the new one; sending only the new one
deletes the rest.
`category_id: null` CLEARS the category. Omitting the key leaves it unchanged.
These are different requests, so do not send an explicit null unless you mean
"remove this group from its category".
At least one changeable field per item is required.
Requires the `student-groups:write` OAuth scope.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| groups | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | Yes | ||
| note | Yes | ||
| total | Yes | ||
| failed | Yes | ||
| succeeded | Yes |