Skip to main content
POST
/
v1
/
lessons
Create a lesson
curl --request POST \
  --url https://api.example.com/v1/lessons \
  --header 'Content-Type: application/json' \
  --data '
{
  "cohort_id": "<string>",
  "unit_id": "<string>",
  "name": "<string>",
  "type": {},
  "position": 123,
  "evaluable": true,
  "optional": true,
  "metadata": {}
}
'
import requests

url = "https://api.example.com/v1/lessons"

payload = {
    "cohort_id": "<string>",
    "unit_id": "<string>",
    "name": "<string>",
    "type": {},
    "position": 123,
    "evaluable": True,
    "optional": True,
    "metadata": {}
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    cohort_id: '<string>',
    unit_id: '<string>',
    name: '<string>',
    type: {},
    position: 123,
    evaluable: true,
    optional: true,
    metadata: {}
  })
};

fetch('https://api.example.com/v1/lessons', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/lessons",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'cohort_id' => '<string>',
    'unit_id' => '<string>',
    'name' => '<string>',
    'type' => [
        
    ],
    'position' => 123,
    'evaluable' => true,
    'optional' => true,
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/lessons"

	payload := strings.NewReader("{\n  \"cohort_id\": \"<string>\",\n  \"unit_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": {},\n  \"position\": 123,\n  \"evaluable\": true,\n  \"optional\": true,\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/v1/lessons")
  .header("Content-Type", "application/json")
  .body("{\n  \"cohort_id\": \"<string>\",\n  \"unit_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": {},\n  \"position\": 123,\n  \"evaluable\": true,\n  \"optional\": true,\n  \"metadata\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/lessons")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cohort_id\": \"<string>\",\n  \"unit_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": {},\n  \"position\": 123,\n  \"evaluable\": true,\n  \"optional\": true,\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

Body

cohort_id
string
required
unit_id
string
Optional grouping unit.
name
string
required
type
enum
default:"reading"
reading | video | practice | assessment.
position
integer
evaluable
boolean
default:"true"
optional
boolean
default:"false"
metadata
object

Examples

const lesson = await hk.lessons.create({
  cohort_id: "coh_123",
  name: "The postulates of special relativity",
  type: "reading",
});
$lesson = $hk->lessons->create([
    'cohort_id' => 'coh_123',
    'name' => 'The postulates of special relativity',
    'type' => 'reading',
]);

Returns

A Lesson.