Create course

POST

public

create-course

Create course

curl --request POST \
  --url https://backend.codedamn.com/api/public/create-course \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "title": "<string>",
        "shortDescription": "<string>",
        "longDescription": "<string>",
        "goals": [
          "<string>"
        ],
        "courseSpecificData": {
          "type": "CohortBasedCourse",
          "cohortStartAt": "<string>",
          "cohortEndAt": "<string>",
          "cohortEnrollmentEndAt": "<string>"
        },
        "thumbnailUrl": "<string>",
        "enrollmentValidityInHours": 2,
        "isSyllabusVisibleOnCourseLandingPage": true,
        "isCourseItemDiscussionEnabled": true,
        "shouldOnlyAllowManualEnrollmentsBySchoolAdmin": true,
        "status": "Draft",
        "faqs": [
          {
            "questionMarkdown": "<string>",
            "answerMarkdown": "<string>"
          }
        ],
        "reviews": [
          {
            "ratingOutOf10": 123,
            "reviewContent": "<string>",
            "nameOfReviewer": "<string>",
            "titleOfReviewer": "<string>",
            "workplaceOfReviewer": "<string>",
            "profilePictureUrlOfReviewer": "<string>"
          }
        ]
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "fermionDigitalProductId": "<string>",
        "slug": "<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.title

string

required

Title of the course

Minimum string length: 1

data.data.shortDescription

string

required

Brief description of the course

data.data.longDescription

string

required

Detailed description of the course

data.data.goals

string[]

required

Array of learning goals/outcomes for the course

data.data.courseSpecificData

object

required

Course type specific data

Option 1
Option 2

Show child attributes

data.data.courseSpecificData.type

enum<string>

required

Type of course - CohortBasedCourse for scheduled cohorts

Available options:

CohortBasedCourse

data.data.courseSpecificData.cohortStartAt

string

required

Cohort start date

data.data.courseSpecificData.cohortEndAt

string

required

Cohort end date

data.data.courseSpecificData.cohortEnrollmentEndAt

string

Cohort enrollment end date (optional)

data.data.thumbnailUrl

string<uri>

URL of the course thumbnail image (optional, will use default placeholder if not provided)

data.data.enrollmentValidityInHours

integer

Number of hours the enrollment is valid for after purchase (optional)

Required range: x >= 1

data.data.isSyllabusVisibleOnCourseLandingPage

boolean

Whether the course syllabus should be visible on the landing page (optional)

data.data.isCourseItemDiscussionEnabled

boolean

Whether discussions are enabled for course items (optional)

data.data.shouldOnlyAllowManualEnrollmentsBySchoolAdmin

boolean

Only admins can enroll students in this course (optional, default: false)

data.data.status

enum<string>

Initial status of the course (defaults to Draft)

Available options:

Draft,

Active,

Unlisted

data.data.faqs

object[]

Array of FAQ objects for the course landing page (optional)

Show child attributes

data.data.faqs.questionMarkdown

string

required

Question text in markdown format

data.data.faqs.answerMarkdown

string

required

Answer text in markdown format

data.data.reviews

object[]

Array of review objects for the course landing page (optional)

Show child attributes

data.data.reviews.ratingOutOf10

number

required

Rating out of 10

data.data.reviews.reviewContent

string

required

Review text content

data.data.reviews.nameOfReviewer

string

required

Name of the reviewer

data.data.reviews.titleOfReviewer

string

Job title of the reviewer (optional)

data.data.reviews.workplaceOfReviewer

string

Workplace/company of the reviewer (optional)

data.data.reviews.profilePictureUrlOfReviewer

string<uri>

URL of the reviewer profile picture (optional)

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

string

required

Unique identifier of the created course product

output.data.slug

string

required

URL-friendly slug for the course, used in subsequent API calls

Get published courses Get details of all published courses with this API Rate limit: Maximum 15 requests in a window of 1m.

⌘I

Create course

curl --request POST \
  --url https://backend.codedamn.com/api/public/create-course \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "title": "<string>",
        "shortDescription": "<string>",
        "longDescription": "<string>",
        "goals": [
          "<string>"
        ],
        "courseSpecificData": {
          "type": "CohortBasedCourse",
          "cohortStartAt": "<string>",
          "cohortEndAt": "<string>",
          "cohortEnrollmentEndAt": "<string>"
        },
        "thumbnailUrl": "<string>",
        "enrollmentValidityInHours": 2,
        "isSyllabusVisibleOnCourseLandingPage": true,
        "isCourseItemDiscussionEnabled": true,
        "shouldOnlyAllowManualEnrollmentsBySchoolAdmin": true,
        "status": "Draft",
        "faqs": [
          {
            "questionMarkdown": "<string>",
            "answerMarkdown": "<string>"
          }
        ],
        "reviews": [
          {
            "ratingOutOf10": 123,
            "reviewContent": "<string>",
            "nameOfReviewer": "<string>",
            "titleOfReviewer": "<string>",
            "workplaceOfReviewer": "<string>",
            "profilePictureUrlOfReviewer": "<string>"
          }
        ]
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "fermionDigitalProductId": "<string>",
        "slug": "<string>"
      }
    }
  }
]

Using API

Endpoints

Authorizations

Body

Response