Skip to main content
PATCH
/
v1
/
courses
/
{id}
Update a course
curl --request PATCH \
  --url https://api.example.com/v1/courses/{id}
import requests

url = "https://api.example.com/v1/courses/{id}"

response = requests.patch(url)

print(response.text)
const options = {method: 'PATCH'};

fetch('https://api.example.com/v1/courses/{id}', 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/courses/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
]);

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

curl_close($curl);

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

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

func main() {

	url := "https://api.example.com/v1/courses/{id}"

	req, _ := http.NewRequest("PATCH", url, nil)

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.example.com/v1/courses/{id}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/courses/{id}")

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

request = Net::HTTP::Patch.new(url)

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

​
Path parameters

​
id
string
required

​
Body

Any of the Course attributes that are writable: name, description, language, hours, ai, tutor, metadata, image.

​
Examples

await hk.courses.update("crs_123", {
  ai: { instructions: "Use SI units throughout. Prefer derivations." },
  tutor: { name: "Dr. Hawking", voice: "encouraging-academic" },
});

$hk->courses->update('crs_123', [
    'ai' => ['instructions' => 'Use SI units throughout. Prefer derivations.'],
    'tutor' => ['name' => 'Dr. Hawking', 'voice' => 'encouraging-academic'],
]);

​
Returns

The updated Course.
update does not propagate to existing cohorts by default. To propagate, pass { propagate: true }:
await hk.courses.update("crs_123", { ai: { ... } }, { propagate: true });

$hk->courses->update('crs_123', ['ai' => [ /* ... */ ]], ['propagate' => true]);