Create new user

POST

public

create-new-user

Create new user

curl --request POST \
  --url https://backend.codedamn.com/api/public/create-new-user \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "userId": "<string>",
        "profileDefaults": {
          "name": "<string>",
          "username": "<string>",
          "email": "[email protected]",
          "profilePictureUrl": "<string>",
          "password": "<string>",
          "phoneNumber": "<string>"
        },
        "shouldSendWelcomeEmail": true
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {}
    }
  }
]

Authorizations

FERMION-API-KEY

string

header

required

Body

application/json

API Request Body

data

object[]

required

Show child attributes

data.data

object

required

Show child attributes

data.data.userId

string

required

Internal userId you have been using for the user in your database

data.data.profileDefaults

object

required

Optional default profile information to set for the new user. All fields are optional and will use system defaults if not provided.

Show child attributes

data.data.profileDefaults.name

string

Pass a value here to set name of user. Leave undefined to keep it as system default

Required string length: 2 - 100

data.data.profileDefaults.username

string

Pass a value here to set username of user. Leave undefined to keep it as system default

Required string length: 3 - 24

data.data.profileDefaults.email

string<email>

Pass a value here to set email of user. Without this, the user will not show up inside the "Users" tab.

data.data.profileDefaults.profilePictureUrl

string<uri>

Pass a value here to set profile photo of user. Leave undefined to keep it as system default

data.data.profileDefaults.password

string

Password for this user account. Leave undefined to not set any password.

Required string length: 6 - 127

data.data.profileDefaults.phoneNumber

string

Pass a value here to set the phone number of the user. Leave undefined to keep it blank.

data.data.shouldSendWelcomeEmail

boolean

If true, a welcome email will be sent to the students with their initial account data from the system

Response

200 - application/json

API Response Body

output

object

required

Option 1
Option 2

Show child attributes

output.status

enum<string>

required

Available options:

ok

output.data

object

required

Get all instructors Get details of all instructors in your school Authentication with the "FERMION-API-KEY" header is required to use this endpoint. Rate limit: Maximum 15 requests in a window of 1m.

⌘I

Create new user

curl --request POST \
  --url https://backend.codedamn.com/api/public/create-new-user \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "userId": "<string>",
        "profileDefaults": {
          "name": "<string>",
          "username": "<string>",
          "email": "[email protected]",
          "profilePictureUrl": "<string>",
          "password": "<string>",
          "phoneNumber": "<string>"
        },
        "shouldSendWelcomeEmail": true
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {}
    }
  }
]

Using API

Endpoints

Authorizations

Body

Response