Create instructor account

POST

public

create-instructor-account

curl --request POST \
  --url https://backend.codedamn.com/api/public/create-instructor-account \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "instructorEmail": "[email protected]",
        "instructorName": "<string>"
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "fermionInstructorId": "<string>",
        "associatedFermionUserId": "<string>"
      }
    }
  }
]

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.instructorEmail

string<email>

required

Email address of the instructor to create

data.data.instructorName

string

required

Full name of the instructor

Required string length: 2 - 100

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

Show child attributes

output.data.fermionInstructorId

string

required

Unique identifier of the created instructor account

output.data.associatedFermionUserId

string

required

Unique identifier of the associated FermionUser account

Create new user Create a new user in the system using the unique userId from your database. Note that this function is idempotent, therefore, calling it multiple times with the same userId will not do anything. Authentication with the "FERMION-API-KEY" header is required to use this endpoint. Rate limit: Maximum 300 requests in a window of 1m.

⌘I

Create instructor account

curl --request POST \
  --url https://backend.codedamn.com/api/public/create-instructor-account \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "instructorEmail": "[email protected]",
        "instructorName": "<string>"
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "fermionInstructorId": "<string>",
        "associatedFermionUserId": "<string>"
      }
    }
  }
]

Using API

Endpoints

Authorizations

Body

Response