Create Category

POST 
/courses/products/:productId/categories

Create a category in a course. Requires a Location token with courses.write. Accepts category columns (title required). locationId, userId, productId, originId are not accepted.

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
parentCategorystringnullable
visibilitystring
Available optionspublisheddraftlockeddrip
posterImagestringnullable
sequenceNonumber
dripDaysnumber
metadataobjectnullable
commentPermissionstringnullable
Optional. Null is treated as omitted (membership defaults to enabled on create).
Available optionshiddenenabledlocked
lockedBystringnullable

Published lesson id in this product that unlocks this category. Must not be a draft lesson, a lesson in a draft module, or a lesson inside this category. When visibility is locked, provide lockedBy, lockedByCategory, or both.

lockedByCategorystringnullable

Published category id in this product that unlocks this category. Must not be this category or a draft module. When visibility is locked, provide lockedBy, lockedByCategory, or both.

titlestringrequired

Category title

Example (auto)

{
  "description": "string",
  "parentCategory": "string",
  "visibility": "published",
  "posterImage": "string",
  "sequenceNo": 1,
  "dripDays": 0,
  "metadata": {
    "dripUnit": "days",
    "dripDate": "string"
  },
  "commentPermission": "hidden",
  "lockedBy": "string",
  "lockedByCategory": "string",
  "title": "Module 1"
}

application/json

Created

application/json

Schema

Schema

idstringrequired

Category id

titlestringrequired
descriptionstringnullablerequired
parentCategorystringnullablerequired
visibilitystringrequired
Available optionspublisheddraftlockeddrip
posterImagestringnullablerequired
sequenceNonumberrequired
dripDaysnumberrequired
metadataobjectnullablerequired
commentPermissionstringrequired
Available optionshiddenenabledlocked
lockedBystringnullablerequired
lockedByCategorystringnullablerequired
createdAtstringrequired
updatedAtstringrequired

Example (auto)

{
  "id": "b2c3d4e5-f678-4901-bcde-f12345678901",
  "title": "Module 1",
  "description": "First module",
  "parentCategory": "string",
  "visibility": "published",
  "posterImage": "string",
  "sequenceNo": 0,
  "dripDays": 0,
  "metadata": {
    "dripUnit": "days",
    "dripDate": "string"
  },
  "commentPermission": "hidden",
  "lockedBy": "string",
  "lockedByCategory": "string",
  "createdAt": "string",
  "updatedAt": "string"
}