Create a cohort
curl --request POST \
--url https://api.example.com/v1/cohorts \
--header 'Content-Type: application/json' \
--data '
{
"course_id": "<string>",
"name": "<string>",
"code": "<string>",
"language": "<string>",
"starts_at": "<string>",
"ends_at": "<string>",
"metadata": {}
}
'import requests
url = "https://api.example.com/v1/cohorts"
payload = {
"course_id": "<string>",
"name": "<string>",
"code": "<string>",
"language": "<string>",
"starts_at": "<string>",
"ends_at": "<string>",
"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({
course_id: '<string>',
name: '<string>',
code: '<string>',
language: '<string>',
starts_at: '<string>',
ends_at: '<string>',
metadata: {}
})
};
fetch('https://api.example.com/v1/cohorts', 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/cohorts",
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([
'course_id' => '<string>',
'name' => '<string>',
'code' => '<string>',
'language' => '<string>',
'starts_at' => '<string>',
'ends_at' => '<string>',
'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/cohorts"
payload := strings.NewReader("{\n \"course_id\": \"<string>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"language\": \"<string>\",\n \"starts_at\": \"<string>\",\n \"ends_at\": \"<string>\",\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/cohorts")
.header("Content-Type", "application/json")
.body("{\n \"course_id\": \"<string>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"language\": \"<string>\",\n \"starts_at\": \"<string>\",\n \"ends_at\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/cohorts")
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 \"course_id\": \"<string>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"language\": \"<string>\",\n \"starts_at\": \"<string>\",\n \"ends_at\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_bodyCohorts
Create a cohort
Start a new run of a course for a group of students.
POST
/
v1
/
cohorts
Create a cohort
curl --request POST \
--url https://api.example.com/v1/cohorts \
--header 'Content-Type: application/json' \
--data '
{
"course_id": "<string>",
"name": "<string>",
"code": "<string>",
"language": "<string>",
"starts_at": "<string>",
"ends_at": "<string>",
"metadata": {}
}
'import requests
url = "https://api.example.com/v1/cohorts"
payload = {
"course_id": "<string>",
"name": "<string>",
"code": "<string>",
"language": "<string>",
"starts_at": "<string>",
"ends_at": "<string>",
"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({
course_id: '<string>',
name: '<string>',
code: '<string>',
language: '<string>',
starts_at: '<string>',
ends_at: '<string>',
metadata: {}
})
};
fetch('https://api.example.com/v1/cohorts', 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/cohorts",
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([
'course_id' => '<string>',
'name' => '<string>',
'code' => '<string>',
'language' => '<string>',
'starts_at' => '<string>',
'ends_at' => '<string>',
'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/cohorts"
payload := strings.NewReader("{\n \"course_id\": \"<string>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"language\": \"<string>\",\n \"starts_at\": \"<string>\",\n \"ends_at\": \"<string>\",\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/cohorts")
.header("Content-Type", "application/json")
.body("{\n \"course_id\": \"<string>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"language\": \"<string>\",\n \"starts_at\": \"<string>\",\n \"ends_at\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/cohorts")
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 \"course_id\": \"<string>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"language\": \"<string>\",\n \"starts_at\": \"<string>\",\n \"ends_at\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_bodyBody
Unique within the course.
Defaults to the course’s language.
ISO date.
Examples
const cohort = await hk.cohorts.create({
course_id: "crs_123",
name: "Fall 2026, Group A",
code: "PHYS-201-FA26-A",
starts_at: "2026-09-01",
ends_at: "2026-12-15",
});
$cohort = $hk->cohorts->create([
'course_id' => 'crs_123',
'name' => 'Fall 2026, Group A',
'code' => 'PHYS-201-FA26-A',
'starts_at' => '2026-09-01',
'ends_at' => '2026-12-15',
]);
Returns
A new Cohort. The course’s syllabus tree is cloned into it.⌘I