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 wholePOST/subjects/{subject_id}/deactivateDeactivate · no deleteshown →
POSTDeactivate a student
Requires subjects:write. There is no delete. An inactive student keeps its history and drops out of every class and every rule. It is reversible.
Path parameters
subject_iduuid · required
The student id.
Body parameters
reasonstring · optional · max 500
Kept on the record.
Returns
200 with the student, status: inactive.
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.