Create Exam
Creates a new exam configuration under the specified course.
The payload includes exam metadata (title, type, URL), proctoring configuration, permitted items, scheduling windows, and instructor-as-proctor settings.
Authorizations
Path Parameters
Unique SID of the application install. Pattern: AI + 32 hex chars.
^AI[a-f0-9]{32}$"AI1234567890abcdef1234567890abcdef"
Unique SID of the course. Pattern: CU + 32 hex chars.
^CU[a-f0-9]{32}$"CU1234567890abcdef1234567890abcdef"
Body
Payload for creating a new exam with full configuration.
Display title for the exam.
"Midterm Exam 1"
Exam type. Online for web-based exams (requires URL and password), Written for paper-based exams.
Online, Written "Online"
Whether to use the proctor manager for automated proctor assignment.
true
Whether exam sessions require manual approval before the student can begin.
false
Exam URL
Whether to show suggested appointment time slots to students during scheduling.
true
Optional description providing additional details about the exam.
"Covers chapters 1-5"
Identifier for the exam delivery system module (e.g., LMS integration module name). Optional field controlled by feature flag.
"canvas"
SID of the user to contact for exam-related issues. Pattern: US + 32 hex chars.
^US[a-f0-9]{32}$"US1234567890abcdef1234567890abcdef"
When true, the exam is assigned to specific students only. When false, all enrolled students can take the exam.
false
Status of the exam. active exams are visible to students, draft are in preparation, deleted are soft-deleted.
active, draft, deleted "active"
Response
Successful
Session status
Exam SID
Course SID
Application install SID
Exam title
Virtual title
Exam type
Description
Use proctor manager
Require approval
Enable appointment suggestions
Exam URL
Exam status
Created date
Last modified date
Contact user SID
Exam delivery system module
Exam summary
Pending approvals count
Open session events count
Course details
Exam configuration
Exam session
Instructor name
Course name
Total sessions
Sessions needing proctor
Script name
System name
Is limited scope
Platform version
