Skip to main content

ArchiveUserCourse

Archives a user's access to a course. The results of this mutation can be affected by providing an authToken header to set a user for the operation.

ArchiveUserCourse(
  id: ID!
): ID

Directives​

authAccess​

This requires the current user to be in STUDENT role.

Arguments​

ArchiveUserCourse.id ● ID! non-null scalar​

The ID of the course to be archived.

Type​

ID scalar​

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Examples​

Run in Postman

Query:​

ArchiveUserCourse($id: ID!) {
 ArchiveUserCourse(id: $id)
}

Variables:​

{
 "id": "a878d8b1-a24b-469b-b52d-02282dccbc0b"
}

Response:​

{
  "data": {
    "ArchiveUserCourse": "a878d8b1-a24b-469b-b52d-02282dccbc0b"
  }
}