Skip to main content
POST
/
users
Create User
curl --request POST \
  --url https://codecombat.com/api/users \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "email": "<string>",
  "role": "student",
  "preferredLanguage": "<string>",
  "heroConfig": {
    "thangType": "<string>"
  },
  "birthday": "<string>"
}'
{
  "_id": "<string>",
  "email": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "role": "<string>",
  "stats": {
    "gamesCompleted": 123,
    "concepts": {},
    "playTime": 123
  },
  "oAuthIdentities": [
    {
      "provider": "<string>",
      "id": "<string>"
    }
  ],
  "subscription": {
    "ends": "<string>",
    "active": true
  },
  "license": {
    "ends": "<string>",
    "active": true
  }
}
Example
url = 'https://codecombat.com/api/users'
json = { email: 'an@email.com', name: 'Some Username', role: 'student' }
request.post({ url, json, auth })

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required
​
email
string
required
​
role
enum<string> | null

"student" or "teacher". If unset, a home user will be created, unable to join classrooms.

Available options:
student,
teacher
​
preferredLanguage
string | null
​
heroConfig
object | null
​
birthday
string | null

Response

200 - application/json

The created user

Subset of properties listed here

​
_id
string | null
​
email
string | null
​
name
string | null
​
slug
string | null
​
role
string | null

Usually either 'teacher' or 'student'

​
stats
object | null
​
oAuthIdentities
UserResponseOAuthIdentitiesItem · object[] | null
​
subscription
object | null
​
license
object | null
⌘I