Create Course

POST 
/courses/products

Create a course in the location. Requires a Location token with courses.write. Accepts product columns and nested customizations. locationId, userId, id, originId, source, and processing are not accepted.

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location id or sub-account id is required.

Possible values: non-empty

application/json

application/json

Body

Bodyrequired

descriptionstringnullable

Course description

posterImagestringnullable

Course poster image URL

customJsstringnullable
customCssstringnullable
customHeaderstringnullable
customFooterstringnullable
commentPrivacystring
Available optionspublicinstructorOnlypublicAndInstructor
libraryOrdernumber

Single-product library position. Membership create always assigns the next order; this value is applied on the follow-up product update. Bulk reordering stays on membership PUT /products/library-order.

customizationsobject
titlestringrequired

Course title

Example (auto)

{
  "description": "Intro to the course",
  "posterImage": "https://cdn.example.com/course.png",
  "customJs": "string",
  "customCss": "string",
  "customHeader": "string",
  "customFooter": "string",
  "commentPrivacy": "public",
  "libraryOrder": 1,
  "customizations": {
    "logoImage": "string",
    "heroImage": "string",
    "heroOverlayColor": "string",
    "heroTextAlignment": "left",
    "heroSpacing": "xs",
    "favicon": "string",
    "instructorHeading": "string",
    "instructorHeadshot": "string",
    "instructorName": "string",
    "instructorTitle": "string",
    "instructorBio": "string",
    "templateId": "string",
    "settings": {},
    "lessonSettings": {}
  },
  "title": "My Course"
}

application/json

Created

application/json

Schema

Schema

idstringrequired

Product id

titlestringrequired

Course title

descriptionstringnullablerequired
posterImagestringnullablerequired

Course poster image URL

customJsstringnullablerequired
customCssstringnullablerequired
customHeaderstringnullablerequired
customFooterstringnullablerequired
commentPrivacystringrequired
Available optionspublicinstructorOnlypublicAndInstructor
libraryOrdernumberrequired
createdAtstringrequired
updatedAtstringrequired
customizationsobjectnullablerequired

Example (auto)

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "title": "My Course",
  "description": "string",
  "posterImage": "https://cdn.example.com/course.png",
  "customJs": "string",
  "customCss": "string",
  "customHeader": "string",
  "customFooter": "string",
  "commentPrivacy": "public",
  "libraryOrder": 0,
  "createdAt": "2026-04-20T10:00:00.000Z",
  "updatedAt": "2026-04-20T10:00:00.000Z",
  "customizations": {
    "id": "d1e2f3a4-b5c6-4789-abcd-ef1234567890",
    "logoImage": "https://cdn.example.com/logo.png",
    "heroImage": "https://cdn.example.com/hero.png",
    "heroOverlayColor": "#000000",
    "heroTextAlignment": "centered",
    "heroSpacing": "medium",
    "favicon": "https://cdn.example.com/favicon.ico",
    "instructorHeading": "Your instructor",
    "instructorHeadshot": "https://cdn.example.com/instructor.png",
    "instructorName": "Jane Doe",
    "instructorTitle": "Lead instructor",
    "instructorBio": "Teaches this course",
    "templateId": null,
    "settings": null,
    "lessonSettings": null
  }
}