Skip to main content
CategoryVersion: v3New

Update Category

PUT/courses/products/{productId}/categories/{categoryId}

Update a category. Requires a Location token with courses.write. Accepts the same category columns as create. All fields optional.

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
categoryIdstring<uuid>required

Category id

Possible values: non-empty

Example:b2c3d4e5-f678-4901-bcde-f12345678901

Query Parameters

locationIdstringrequired

Location id or sub-account id is required.

Possible values: non-empty

Example:ve9EPM428h8vShlRW1KT

Body

application/json
descriptionstringnullable
parentCategorystringnullable
visibilitystring
Available optionspublisheddraftlockeddrip
posterImagestringnullable
sequenceNonumber
Example:1
dripDaysnumber
Example:0
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.

titlestring

Category title

Example:Module 1

Response

application/json

Success

idstringrequired

Category id

Example:b2c3d4e5-f678-4901-bcde-f12345678901
titlestringrequired
Example:Module 1
descriptionstringnullablerequired
Example:First module
parentCategorystringnullablerequired
visibilitystringrequired
Available optionspublisheddraftlockeddrip
posterImagestringnullablerequired
sequenceNonumberrequired
dripDaysnumberrequired
metadataobjectnullablerequired
commentPermissionstringrequired
Available optionshiddenenabledlocked
lockedBystringnullablerequired
lockedByCategorystringnullablerequired
createdAtstringrequired
updatedAtstringrequired