Skip to content
PassionPassion developers

Change the name, summary or cover of a lesson

PATCH
/apps/{appId}/courses/{courseId}/lessons/{lessonId}
curl --request PATCH \
  --url https://api.passion.io/v1/apps/example/courses/example/lessons/example \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "summary": "example", "coverFileId": "example" }'

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]*$/
courseId
required

The id of a course, as list_courses lists it.

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

The id of a lesson, as get_course or create_lesson answers it.

string
/^[0-9A-Za-z-]+$/

Request Body

Section titled “Request Body”
Media typeapplication/json
object
name

The new name of the lesson.

string
>= 1 characters
summary

The new summary of the lesson.

string
>= 1 characters
coverFileId

An uploaded image that becomes the cover of the lesson.

string
/^[1-9][0-9]*$/
Examplegenerated
{
  "name": "example",
  "summary": "example",
  "coverFileId": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
lessonId
required
string
courseId
required
string
name
required
string
summary
required
Any of:
string
Examplegenerated
{
  "lessonId": "example",
  "courseId": "example",
  "name": "example",
  "summary": "example"
}