SchoolSet APIStudent Management

Update student

Updates the selected student record.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Path parameters

idstringRequired

Request

This endpoint expects an object.
firstnamestring or nullRequired
The firstname of the student.
lastnamestring or nullRequired
The lastname of the student.
emailstring or nullRequiredformat: "email"
The email of the student.
dobdate or nullRequired
The dob of the student.
genderstring or nullRequired
The gender of the student.
addressstring or nullRequired
The address of the student.
citystring or nullRequired
The city of the student.
statestring or nullRequired
The state of the student.
countrystring or nullRequired
The country of the student.
zipstring or nullRequired
The zip of the student.
gov_idstring or nullRequired

The gov_id of the student.

0enumOptional
0 value.
Allowed values:
firstname_hebrewstring or nullOptional
The firstname of the student.
lastname_hebrewstring or nullOptional
The lastname of the student.
phonestring or nullOptional
Must not be greater than 255 characters.
dob_hebrewstring or nullOptional
dob hebrew date value.
holy_name_studentstring or nullOptional
holy name student display value.
medical_infostring or nullOptional
medical info value.
allergiesstring or nullOptional
allergies value.
missing_immunizationstring or nullOptional
missing immunization value.
required_formsstring or nullOptional
required forms flag.
status_iddouble or nullOptional
status ID status value.
family_iddouble or nullOptional
family ID identifier.
academ_year_iddouble or nullOptional
academ year ID identifier.
legal_namestring or nullOptional
Must not be greater than 255 characters.
medical_notestring or nullOptional
Must not be greater than 1000 characters.
kodesh_namestring or nullOptional
Must not be greater than 255 characters.
class_iddouble or nullOptional
class ID identifier.
grade_iddouble or nullOptional
grade ID identifier.
academic_year_iddouble or nullOptional
academic year ID identifier.

Response

JSON response payload for student update.
statusenum
Allowed values:
messagestring
dataobject