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

Documentation Index

Fetch the complete documentation index at: https://docs.hawkings.education/llms.txt

Use this file to discover all available pages before exploring further.

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" },
});

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 });