Sign in

v1

latestOpenAPI 3.0.32026-07-173038118.9 KB
Products

Update product metadata

patch/api/products/{productId}

Path parameters

productIdstring required

Request body

titlestring

Product title shown in CourseLit.

slugstring

Optional URL slug.

descriptionstring

Optional product/blog description. Send this as a JSON-stringified Tiptap/ProseMirror document, for example JSON.stringify({ type: "doc", content: [] }). Do not use a content field on this endpoint.

publishedboolean

Whether the product is published. Existing CourseLit publishing checks still apply.

privacystring

Existing CourseLit product privacy value.

tagsstring[]
featuredImageobject

Example request

{
  "title": "AI Foundations",
  "slug": "ai-foundations",
  "description": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Updated course description.\"}]}]}",
  "privacy": "unlisted"
}

Response

Success.

productIdstring
type'course' | 'download' | 'blog'
titlestring
slugstring
descriptionstring
publishedboolean
privacystring
tagsstring[]
featuredImageobject
pageIdstring
defaultPaymentPlanstring
createdAtstring date-time
updatedAtstring date-time