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.

Request

Version stringrequired

API Version

Available optionsv3

productId string<uuid>required

Product id

Possible values: non-empty

locationId stringrequired

Location id or sub-account id is required.

Possible values: non-empty

application/json

application/json

Body

Bodyrequired

descriptionstringnullable
visibilitystring
Available optionsdraftpublishedlocked
posterImagestringnullable
sequenceNonumber
commentStatusstring
Available optionsvisiblehiddenlocked
contentIdstringnullable
contentTypestring
Available optionsvideoassignmentquizaudiofunnel
commentPermissionstring
Available optionshiddenenabledlocked
lockedByPoststringnullable
lockedByCategorystringnullable
certificateTemplateIdstringnullable
metaDataobjectnullable
titlestringrequired

Lesson title

categoryIdstringrequired

Category id

Example (auto)

{
  "description": "string",
  "visibility": "draft",
  "posterImage": "string",
  "sequenceNo": 1,
  "commentStatus": "visible",
  "contentId": "string",
  "contentType": "video",
  "commentPermission": "hidden",
  "lockedByPost": "string",
  "lockedByCategory": "string",
  "certificateTemplateId": "string",
  "metaData": {},
  "title": "Lesson 1",
  "categoryId": "b2c3d4e5-f678-4901-bcde-f12345678901"
}

application/json

Created

application/json

Schema

Schema

idstringrequired

Lesson id

titlestringrequired
descriptionstringnullablerequired
categoryIdstringrequired
visibilitystringrequired
Available optionsdraftpublishedlocked
posterImagestringnullablerequired
sequenceNonumberrequired
commentStatusstringrequired
Available optionsvisiblehiddenlocked
contentIdstringnullablerequired
contentTypestringrequired
Available optionsvideoassignmentquizaudiofunnel
commentPermissionstringrequired
Available optionshiddenenabledlocked
lockedByPoststringnullablerequired
lockedByCategorystringnullablerequired
certificateTemplateIdstringnullablerequired
metaDataobjectnullablerequired
createdAtstringrequired
updatedAtstringrequired

Example (auto)

{
  "id": "c3d4e5f6-7890-4123-cdef-123456789012",
  "title": "Lesson 1",
  "description": "string",
  "categoryId": "string",
  "visibility": "draft",
  "posterImage": "string",
  "sequenceNo": 0,
  "commentStatus": "visible",
  "contentId": "string",
  "contentType": "video",
  "commentPermission": "hidden",
  "lockedByPost": "string",
  "lockedByCategory": "string",
  "certificateTemplateId": "string",
  "metaData": {},
  "createdAt": "string",
  "updatedAt": "string"
}