Skip to main content
POST
Create a course lesson

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Body

application/json

The new CourseLesson resource

uuid
string | null
section
string<iri-reference>
Example:

"/api/v1/course_sections/1"

title
string
content
string | null
hasMedia
boolean | null
default:false
mediaType
string | null
mediaUrl
string | null
status
string | null
default:draft
position
integer | null
default:0
estimatedDuration
integer | null
settings
(string | null)[] | null

Response

CourseLesson resource created

id
integer
read-only
uuid
string | null
section
string<iri-reference>
Example:

"/api/v1/course_sections/1"

title
string
content
string | null
hasMedia
boolean | null
default:false
mediaType
string | null
mediaUrl
string | null
mediaFile
string<iri-reference> | null
Example:

"/api/v1/media/1"

status
string | null
default:draft
position
integer | null
default:0
estimatedDuration
integer | null
settings
(string | null)[] | null
dateCreated
string<date-time>
dateUpdated
string<date-time>
attachments
string<iri-reference>[]
read-only
Example:
requiresCompletion
boolean | null
published
boolean
read-only
draft
boolean
read-only
course
string<iri-reference> | null
read-only
Example:

"/api/v1/courses/1"