Skip to main content
PATCH
Update a course enrollment

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.

Path Parameters

uuid
string
required

CourseEnrollment identifier

Body

application/merge-patch+json

The updated CourseEnrollment resource

course
string<iri-reference>
Example:

"/api/v1/courses/1"

user
string<iri-reference>
Example:

"/api/v1/users/1"

progress
number
default:0
status
string
default:enrolled
progressData
(string | null)[] | null

Response

CourseEnrollment resource updated

id
integer
read-only
uuid
string | null
user
object
enrolledAt
string<date-time>
lastAccessedAt
string<date-time> | null
progress
number
default:0
status
string
default:enrolled
progressData
(string | null)[] | null
dateUpdated
string<date-time>