UpdateCourseStatus

Used to change the course status to either started, not-completed, or completed for the current user. One of id, slug, or sku must be provided to identify the course. The optional statusChangeDate must be a valid date and cannot be in the future. If omitted, the current date and time is used. The results of this mutation can be affected by providing an authToken header to set a user for the operation.

UpdateCourseStatus(
  id: ID
  slug: Slug
  sku: String
  status: String!
  statusChangeDate: Date
): Boolean!

Directives

authAccess

This requires the current user to be in STUDENT role.

Arguments

UpdateCourseStatus.id ● ID scalar

The unique ID of the course.

UpdateCourseStatus.slug ● Slug scalar

The slug of the course.

UpdateCourseStatus.sku ● String scalar

The SKU of the course.

UpdateCourseStatus.status ● String! non-null scalar

The status to set for the course. Must be one of: started, not-completed, completed.

UpdateCourseStatus.statusChangeDate ● Date scalar

The date and time the course status was changed (ISO 8601 format). If omitted, the current date and time is used.

Type

Boolean scalar

The Boolean scalar type represents true or false.

Examples

Query:

UpdateCourseStatus(
 $id: ID,
 $slug: Slug,
 $sku: String,
 $status: String!,
 $statusChangeDate: Date
) {
 UpdateCourseStatus(
   id: $id,
   slug: $slug,
   sku: $sku,
   status: $status,
   statusChangeDate: $statusChangeDate
 )
}

Variables:

{
 "id": "64395d3f-f3f9-4df5-9920-f820af1e5d7c",
 "slug": "Slug",
 "sku": "xyz789",
 "status": "xyz789",
 "statusChangeDate": "2025-09-03T18:58:37.143Z"
}

Response:

{
  "data": {
    "UpdateCourseStatus": false
  }
}