Skip to content
PassionPassion developers

Create a draft course with its outline

POST
/apps/{appId}/courses
curl --request POST \
  --url https://api.passion.io/v1/apps/example/courses \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "summary": "example", "coverFileId": "example", "sections": [] }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
appId
required

The id of the App, as Studio shows it.

string
/^[1-9][0-9]*$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required

The name of the course, as members see it.

string
>= 1 characters
summary
required

One or two sentences that tell members what the course is about.

string
>= 1 characters
coverFileId

An uploaded image that is the cover of the course.

string
/^[1-9][0-9]*$/
sections

The outline: the sections of the course in order, each with its lessons. Leave it out for an empty course.

Array<object>
default:
object
name
required

The name of the section, as members see it in the course.

string
>= 1 characters
lessons
required

The lessons of the section, in the order members see them.

Array<object>
object
name
required

The name of the lesson, as members see it in the course.

string
>= 1 characters
summary

One or two sentences under the name.

string
>= 1 characters

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
courseId
required
string
name
required
string
sections
required
Array<object>
object
sectionId
required
string
name
required
string
lessons
required
Array<object>
object
lessonId
required
string
name
required
string
Examplegenerated
{
  "courseId": "example",
  "name": "example",
  "sections": [
    {
      "sectionId": "example",
      "name": "example",
      "lessons": [
        {
          "lessonId": "example",
          "name": "example"
        }
      ]
    }
  ]
}