Enroll User in a Course

Enrolls a user in a course in a classroom. If the course is paid, user must have an active license. User must be a member of the classroom.

PUT /classrooms/{classroomHandle}/courses/{courseHandle}/enrolled

Try it

Enroll User in a Course

cURL

curl --request PUT \
  --url https://codecombat.com/api/classrooms/{classroomHandle}/courses/{courseHandle}/enrolled \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "<string>"
}
'

200

{
  "_id": "<string>",
  "name": "<string>",
  "members": [
    "<string>"
  ],
  "ownerID": "<string>",
  "description": "<string>",
  "courses": [
    {
      "_id": "<string>",
      "levels": [
        {}
      ],
      "enrolled": [
        "<string>"
      ],
      "instance_id": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

classroomHandle · string · required

The classroom's _id.

courseHandle · string · required

The course's _id.

Query Parameters

retMemberLimit · number<double> | null

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

Body

application/json

userId · string · required

Response

200 - application/json

The classroom with the user enrolled.

Subset of properties listed here

_id · string | null

name · string | null

members · string[] | null

ownerID · string | null

description · string | null

courses · ClassroomResponseCoursesItem · object[] | null

Show child attributes

courses. _id · string | null

courses. levels · object[] | null

courses. enrolled · string[] | null

courses. instance_id · string | null