API ReferenceClassrooms

Upsert a user from classroom

Upserts a user into the classroom.

Path parameters

handlestringRequired

The document’s _id or slug.

Headers

AuthorizationstringRequired

Basic authentication of the form Basic <username:password>.

Request

This endpoint expects an object.
codestringRequired
The code for joining this classroom
userIdstringRequired

The _id or slug of the user to add to the class.

retMemberLimitdoubleOptional
limit the return number of members for the classroom, the default value is 1000

Response

This endpoint returns an object.
_idstring or null
namestring or null
memberslist of strings or null
ownerIDstring or null
descriptionstring or null
courseslist of objects or null