Upsert a user from classroom

Upserts a user into the classroom.

PUT /classrooms/{handle}/members

Upsert a user from classroom

cURL

curl --request PUT \
  --url https://codecombat.com/api/classrooms/{handle}/members \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "userId": "<string>",
  "retMemberLimit": 123
}
'

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

handle · string · required

The document's _id or slug.

Body

application/json

code · string · required

The code for joining this classroom

userId · string · required

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

retMemberLimit · number<double> | null

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

Response

200 - application/json

The classroom with the member added.

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