LessonVersion: v3New

Create Lesson

POST/courses/products/{productId}/lessons

Create a lesson. Requires title and categoryId. Accepts lesson columns. locationId, userId, productId, originId are not accepted. Requires a Location token with courses.write.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:courses.write

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

API Version

Available optionsv3

Example:v3

Path Parameters

productIdstring<uuid>required

Product id

Possible values: non-empty

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Query Parameters

locationIdstringrequired

Location id or sub-account id is required.

Possible values: non-empty

Example:ve9EPM428h8vShlRW1KT

Body

application/json

descriptionstringnullable

visibilitystring

Available optionsdraftpublishedlocked

posterImagestringnullable

sequenceNonumber

Example:1

commentStatusstring

Available optionsvisiblehiddenlocked

contentIdstringnullable

contentTypestring

Available optionsvideoassignmentquizaudiofunnel

commentPermissionstring

Available optionshiddenenabledlocked

lockedByPoststringnullable

lockedByCategorystringnullable

certificateTemplateIdstringnullable

metaDataobjectnullable

titlestringrequired

Lesson title

Example:Lesson 1

categoryIdstringrequired

Category id

Example:b2c3d4e5-f678-4901-bcde-f12345678901

Response

application/json

Created

idstringrequired

Lesson id

Example:c3d4e5f6-7890-4123-cdef-123456789012

titlestringrequired

Example:Lesson 1

descriptionstringnullablerequired

categoryIdstringrequired

visibilitystringrequired

Available optionsdraftpublishedlocked

posterImagestringnullablerequired

sequenceNonumberrequired

commentStatusstringrequired

Available optionsvisiblehiddenlocked

contentIdstringnullablerequired

contentTypestringrequired

Available optionsvideoassignmentquizaudiofunnel

commentPermissionstringrequired

Available optionshiddenenabledlocked

lockedByPoststringnullablerequired

lockedByCategorystringnullablerequired

certificateTemplateIdstringnullablerequired

metaDataobjectnullablerequired

createdAtstringrequired

updatedAtstringrequired