Skip to main content
POST
Exam mode — pause or resume the current Digital Twin for students

Authorizations

Authorization
string
header
required

JWT token passed in authorization header

Body

application/json
paused
boolean
required

true pauses, false resumes

scope
enum<string>

Defaults to course

Available options:
course,
all
contextId
string

The course to pause or resume (scope course). Defaults to the course the caller opened the Digital Twin from, otherwise one of the courses GET lists

until
string<date-time> | null

Optional end time, in the future and at most 30 days ahead

message
string

Optional text students see instead of the default

Maximum string length: 300
name
string

Optional display name of the course

Maximum string length: 120
expectTwinId
string

Optional. The Digital Twin the screen showed. The write is refused with 409 when the caller's current Digital Twin is not the one named

expectContextId
string

Optional. The course the screen showed. The write is refused with 409 when the caller's current course is not the one named

Response

The new Exam mode state (same shape as GET), plus profileExamPause

success
boolean
twin
object
examMode
object

Same shape as GET

profileExamPause
object | null

What the top bar's switch shows after the change, for a session opened by an LMS launch of this Digital Twin. null otherwise, or when it could not be read (the change itself was made)