Skip to content

Update a course module

PATCH
/api/tenants/{tenant_id}/courses/{course_id}/modules/{module_id}

PATCH /api/tenants/:tenant_id/courses/:course_id/modules/:module_id

Requires instructor permission on the course

Parameters

Path Parameters

tenant_id
required
string format: uuid

Tenant ID

course_id
required
string format: uuid

Course ID

module_id
required
string format: uuid

Module ID

Request Bodyrequired

Payload for updating a course module

object
description
string | null
estimated_duration_minutes
integer | null format: int32
is_required
boolean | null
is_visible
boolean | null
position
integer | null format: int32
section_id

Section assignment. Omit to leave unchanged; null to unassign (move to no section); a UUID to assign to that section. (The double-Option encodes omitted-vs-null; OpenAPI can only render it as a nullable UUID, so this note is the contract for the omitted-vs-null distinction.)

string | null format: uuid
title
string | null

Responses

200

Module updated

Course module model representing units within sections

object
available_from
string | null format: date-time
available_until
string | null format: date-time
block_display_mode
One of:
null
completion_criteria
content_data
content_id
string | null format: uuid
content_type
string | null
course_id
required
string format: uuid
created_at
required
string format: date-time
description
string | null
estimated_duration_minutes
integer | null format: int32
has_children
boolean | null
id
required
string format: uuid
is_graded
boolean | null
is_published
boolean | null
is_required
boolean | null
is_visible
boolean | null
module_type
required
string
points_possible
string | null
position
required
integer format: int32
prerequisites
published_at
string | null format: date-time
section_id
string | null format: uuid
settings
title
required
string
updated_at
required
string format: date-time
weight
string | null

401

Unauthorized