Create chapter
/api/v1/chapters/Create right on Chapters (coursechapters:create).Create a new chapter inside an existing course.
Request bodyapplication/jsonRequired
namestringRequireddescriptionstring | nullOptionalthumbnail_imagestring | nullOptionallock_typeLockTypeOptionalorg_idintegerRequiredcourse_idintegerRequiredextra_metadataExtra Metadata | nullOptionalResponses4
200Chapter created successfullyChapterRead
namestringRequireddescriptionstring | nullthumbnail_imagestring | nulllock_typeLockTypeorg_idintegerRequiredcourse_idintegerRequiredidintegerRequiredactivitiesActivityRead[]Required20 child attributes
namestringRequiredactivity_typeActivityTypeEnumRequiredactivity_sub_typeActivitySubTypeEnumRequiredcontentContentOptionaldetailsDetails | nullOptionalpublishedbooleanOptionallock_typeActivityLockTypeOptionalidintegerRequiredorg_idintegerRequiredcourse_idintegerRequiredactivity_uuidstringRequiredcreation_datestringRequiredupdate_datestringRequiredextra_metadataExtra Metadata | nullOptionalcurrent_versionintegerOptionallast_modified_by_idinteger | nullOptionallast_modified_by_usernamestring | nullOptionalis_lockedbooleanOptionaldrip_unlock_atstring | nullOptionaldrip_reasonstring | nullOptionalchapter_uuidstringRequiredcreation_datestringRequiredupdate_datestringRequiredextra_metadataExtra Metadata | nullis_lockedbooleandrip_ruleDrip Rule | nulldrip_lockedbooleandrip_unlock_atstring | nulldrip_reasonstring | nulldrip_closes_atstring | nullcurl -X POST \
"https://api.learnhouse.io/api/v1/chapters/" \
-H "Authorization: Bearer lh_YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example name","description":"An example description","thumbnail_image":"string","lock_type":"public","org_id":1,"course_id":1,"extra_metadata":{}}'import { createClient } from "@learnhouse/sdk";
const lh = createClient({ baseUrl: "https://api.learnhouse.io", token: "lh_YOUR_API_TOKEN" });
const data = await lh.POST("/api/v1/chapters/", {
body: {
"name": "Example name",
"description": "An example description",
"thumbnail_image": "string",
"lock_type": "public",
"org_id": 1,
"course_id": 1,
"extra_metadata": {}
},
});
console.log(data);const res = await fetch("https://api.learnhouse.io/api/v1/chapters/", {
method: "POST",
headers: {
Authorization: "Bearer lh_YOUR_API_TOKEN",
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "Example name",
"description": "An example description",
"thumbnail_image": "string",
"lock_type": "public",
"org_id": 1,
"course_id": 1,
"extra_metadata": {}
}),
});
const data = await res.json();
console.log(data);import requests
res = requests.post(
"https://api.learnhouse.io/api/v1/chapters/",
headers={"Authorization": "Bearer lh_YOUR_API_TOKEN"},
json={
"name": "Example name",
"description": "An example description",
"thumbnail_image": "string",
"lock_type": "public",
"org_id": 1,
"course_id": 1,
"extra_metadata": {
},
},
)
print(res.json()){
"name": "Example name",
"description": "An example description",
"thumbnail_image": "string",
"lock_type": "public",
"org_id": 1,
"course_id": 1,
"id": 1,
"activities": [
{
"name": "Example name",
"activity_type": "TYPE_VIDEO",
"activity_sub_type": "SUBTYPE_DYNAMIC_PAGE",
"content": {},
"details": {},
"published": false,
"lock_type": "public",
"id": 1,
"org_id": 1,
"course_id": 1,
"activity_uuid": "string",
"creation_date": "string",
"update_date": "string",
"extra_metadata": {},
"current_version": 1,
"last_modified_by_id": 1,
"last_modified_by_username": "string",
"is_locked": false,
"drip_unlock_at": "string",
"drip_reason": "string"
}
],
"chapter_uuid": "string",
"creation_date": "string",
"update_date": "string",
"extra_metadata": {},
"is_locked": false,
"drip_rule": {},
"drip_locked": false,
"drip_unlock_at": "string",
"drip_reason": "string",
"drip_closes_at": "string"
}