API reference
Students
/subjects
A student is what events are about. Parents are linked to students through /links. In the High school pack a student is, for example, “Musu Kollie” with reference STU-2026-001.
GET/subjectsList · ?q ?external_refPOST/subjectsCreateGET/subjects/{subject_id}ReadPATCH/subjects/{subject_id}Update · attributes replaced wholeshown →POST/subjects/{subject_id}/deactivateDeactivate · no delete
PATCHUpdate a student
Requires subjects:write. Send only the fields you are changing — except attributes, which is replaced whole. To change one attribute, send them all.
Path parameters
subject_iduuid · required
The student id.
Body parameters
display_namestring · optional
external_refstring · optional · max 200
Changed here, never emptied: blank leaves the one on file alone.
attributesobject · optionalVaries by pack
Generated from the High school pack's subject_schema. PATCH replaces the whole object; it does not merge.
KeyLabelKindAllowed valuesRequired
yearYear grouptext—No
classClasstext—No
Returns
200 with the updated student. 400 if attributes contains an unknown key.
Response body
One student: the same fields in every pack. Press Response on the sample to see one whole.
FieldTypeDescription
iduuid
tenant_iduuidThe instance.
external_refstring | nullYour own id, as you sent it.
display_namestring
attributesobjectShaped by the High school pack's subject_schema.Varies by pack
statusactive | inactive
created_atdatetime
updated_atdatetime
On failure the body is { error, code } instead.