Skip to navigation

CreateCourse

View as Markdown

Create a course in your school’s course catalogue.

Accepted fields: name, code, description, teachingHours, units. Anything else is ignored.

The course is always created in your school. Returns it in the same shape as GetSchoolCourses; use its id when creating a class (CreateClass).

Fires the COURSE_CREATED webhook.

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.
namestringRequired
codestringRequired
descriptionstringRequired
teachingHoursintegerRequired
unitsintegerRequired

Response headers

Access-Control-Allow-OriginstringOptional
Access-Control-Allow-MethodsstringOptional
X-Content-Type-OptionsstringOptional
Cache-ControlstringOptional

Response

OK
namestring
idinteger
unitsinteger
descriptionstring
codestring
teachingHoursinteger