Skip to main content
PATCH
/
course_chapters
/
{id}
JavaScript
import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const courseChapter = await client.courseChapters.update('chap_xxxxxxxxxxxxx', { title: 'title' });

console.log(courseChapter.id);
{
  "id": "chap_xxxxxxxxxxxxx",
  "title": "Getting Started",
  "order": 42,
  "lessons": [
    {
      "id": "lesn_xxxxxxxxxxxxx",
      "title": "Understanding Candlestick Patterns",
      "order": 42
    }
  ]
}

Authorizations

​
Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

​
id
string
required

The unique identifier of the chapter to update (e.g., "chap_XXXXX").

Example:

"chap_xxxxxxxxxxxxx"

Body

application/json

Parameters for UpdateChapter

​
title
string
required

The new display title of the chapter (e.g., "Module 1: Introduction").

Response

A successful response

A grouping of related lessons within a course, used to organize content into sections.

​
id
string
required

The unique identifier for the chapter.

Example:

"chap_xxxxxxxxxxxxx"

​
title
string
required

The display name of the chapter shown to students. Maximum 150 characters.

Example:

"Getting Started"

​
order
integer
required

The sort position of this chapter within its parent course, starting from zero.

Example:

42

​
lessons
object[]
required

An ordered list of lessons in this chapter, sorted by display position. Hidden lessons are excluded for non-admin users.