DreamClass APIStudents

CreateStudent

View as Markdown
Add a student record

Headers

dreamclass-secret-keystringOptional

Your DreamClass API key. Required on every request. Find it in the DreamClass app under Settings > Integrations.

tenantstringOptional
Your tenant code: the DreamClass subdomain you sign in at (for https://myaccount.dreamclass.io it is "myaccount"), or your full white-labelled domain. Required on every request.
schoolCodestringOptional

Your school code. Required on every request. Find it in the DreamClass app under Settings > Integrations.

Request

This endpoint expects an object.
emailstringRequiredformat: "email"
firstnamestringRequired
lastnamestringRequired
middlenamestringRequired
mobilestringRequired
addressstringRequired
genderstringRequired
countrystringRequired
citystringRequired
telephonestringRequired
birthdatedateRequired
birthplacestringRequired
customFieldsobjectRequired

Response headers

ExpiresstringOptional
Cache-ControlstringOptional
Access-Control-Allow-HeadersstringOptional
X-XSS-ProtectionstringOptional
PragmastringOptional
Access-Control-Allow-MethodsstringOptional
X-Frame-OptionsstringOptional
Access-Control-Expose-HeadersstringOptional
Access-Control-Allow-OriginstringOptional
Access-Control-Allow-CredentialsstringOptional
X-Content-Type-OptionsstringOptional
Access-Control-Max-AgestringOptional

Response

OK
idinteger
emailstringformat: "email"
firstnamestring
lastnamestring
middlenamestring
mobilestring
addressstring
genderstring
countrystring
citystring
telephonestring
birthdatedate
birthplacestring
customFieldsobject
schoolPeriodsanyOptional
guardiansanyOptional