quizzes

Every question of the bank — archived ones included, since they keep their slot — in the order to present them; first is position 0.

1–1000 items

true_false: answered true or false. multiple_choice: exactly one correct option. multi_select: several options may be correct, scored all-or-nothing. ordering: the options are items whose authored order is the answer. short_answer: the options are the accepted spellings of a typed answer. numeric: a number within a tolerance of correct_number. matching: each option is a label/match_label pair the taker reunites. fill_in_blank: the prompt's runs of three or more underscores are blanks, and the options are the accepted answers, each naming its blank_index. long_answer: a free-text essay answer with no accepted spellings, always graded by hand. drawing: the taker draws on a canvas, over drawing_starting_image when one is attached, always graded by hand.

one of "true_false" | "multiple_choice" | "multi_select" | "ordering" | "short_answer" | "numeric" | "matching" | "fill_in_blank" | "long_answer" | "drawing"

On fill_in_blank questions, every run of three or more underscores (___) is one blank, up to 10 per prompt.

1–2000 characters

Defaults to plaintext.

one of "plaintext" | "markdown" | "pdf"

Omit to draw the PDF beside the question. Send false for a long reference the taker downloads and works from instead, so it does not bury the answers. Remembered across replacements of the file.

Omit or send empty for no explanation.

at most 2000 characters

Defaults to 1.

minimum 1 · maximum 1000

Defaults to false, except for long_answer and drawing questions, which are always manual (sending false for one is refused).

Omit or send empty for no rubric.

at most 50000 characters

Defaults to false: the rubric reaches markers only.

Required for true_false questions; omit for every other kind.

numeric questions only.

numeric questions only; 0 demands the exact value.

minimum 0

Required for every kind with options; omit for true_false, numeric, long_answer and drawing.

1–50 items

drawing questions only: the image the taker draws over, as a base64 data URL. Omit (or send null) for a blank canvas.

at most 3000000 characters · matches ^data:image\/(png|jpeg|webp|gif);base64,[A-Za-z0-9+/]+=*$

1–300 characters

maximum 26214400

Organization the bank belongs to. Always required.

Omit for a bank owned by the organization directly.

Unique within the organization. Slugs are lowercase letters and digits in words separated by single hyphens, like fire-safety-basics.

1–100 characters · matches ^[a-z0-9]+(-[a-z0-9]+)*$

1–200 characters

Omit or send empty for no description.

at most 2000 characters

1–100 characters · matches ^[a-z0-9]+(-[a-z0-9]+)*$

1–200 characters

Send null to clear the description.

at most 2000 characters

True archives the bank — it stops feeding new attempts through any quiz link — and false restores it. History is untouched either way.

The bank to copy or move the question into — one of the question's own organization. A copy may land in the question's own bank.

The bank to copy or move the question into — one of the question's own organization. A copy may land in the question's own bank.

On fill_in_blank questions the new prompt's blanks must still be covered by the options — send both when adding or removing a blank.

1–2000 characters

Switching between plaintext and markdown re-renders the same prompt text. Switching to pdf needs prompt_pdf (unless one is already attached); switching away discards the attachment.

one of "plaintext" | "markdown" | "pdf"

Omit to draw the PDF beside the question. Send false for a long reference the taker downloads and works from instead, so it does not bury the answers. Remembered across replacements of the file.

Send null to clear the explanation.

at most 2000 characters

Applies to papers built from now on; attempts already started keep the points they were built with.

minimum 1 · maximum 1000

Applies to papers built from now on. Cannot be switched off on a long_answer or drawing question.

Send null or empty to clear the rubric.

at most 50000 characters

Whether takers see the rubric too — beneath the prompt while answering, and again in answer review. Off, the rubric reaches markers only.

For true_false questions only.

numeric questions only.

numeric questions only; 0 demands the exact value.

minimum 0

For questions with options only. Replaces the whole option set; answer review of attempts that saw the old options degrades accordingly. Grading of submitted attempts never changes.

1–50 items

drawing questions only: replaces the starting image; send null to clear it. Papers already started keep the canvas they opened with.

at most 3000000 characters · matches ^data:image\/(png|jpeg|webp|gif);base64,[A-Za-z0-9+/]+=*$

Omit or send empty for an unlabelled sitting.

1–200 characters

Defaults to assignees. A roster sitting starts with an empty roster.

one of "assignees" | "roster"

Send null to clear the label.

1–200 characters

Switching to assignees keeps the roster for a later switch back; switching to roster admits only whoever is on it.

one of "assignees" | "roster"

A member of the quiz's organization who is assigned the quiz, individually or through a role they hold.

Assign to every holder of this department role.

Assign to one member of the quiz's organization, by user id.

Replaces the quiz's bank links; array order is presentation order.

at most 50 items

Replaces the quiz's subject-matter tags.

at most 50 items

1–100 characters · matches ^[a-z0-9]+(-[a-z0-9]+)*$

1–200 characters

Send null to clear the description.

at most 2000 characters

Send null or empty to clear the closing note.

at most 50000 characters

live: takeable only while one of the quiz's scheduled sittings (scheduled_quizzes) is open — the same quiz can be scheduled year after year. async: self-scheduled, takeable whenever the quiz is published; sittings do not apply.

one of "live" | "async"

Send null to remove the time limit.

fixed: every question in authored order, the same for everyone. shuffle: every question, order and options shuffled per attempt. random_draw: each bank link contributes draw_count randomly chosen questions (all when null), shuffled.

one of "fixed" | "shuffle" | "random_draw"

Score required to pass, as a percentage of the questions presented.

minimum 0 · maximum 100

Send null for unlimited attempts.

The copy's name; omit for the original's with " (copy)" appended.

1–200 characters

The copy's slug, unique within the organization; omit for the first free `-copy`, `-copy-2`… of the original's. Slugs are lowercase letters and digits in words separated by single hyphens, like fire-safety-basics.

1–100 characters · matches ^[a-z0-9]+(-[a-z0-9]+)*$

Organization the quiz belongs to. Always required.

Omit for a quiz owned by the organization directly.

Unique within the organization. Slugs are lowercase letters and digits in words separated by single hyphens, like fire-safety-basics.

1–100 characters · matches ^[a-z0-9]+(-[a-z0-9]+)*$

1–200 characters

Omit or send empty for no description.

at most 2000 characters

Omit or send empty for no closing note.

at most 50000 characters

live: takeable only while one of the quiz's scheduled sittings (scheduled_quizzes) is open — the same quiz can be scheduled year after year. async: self-scheduled, takeable whenever the quiz is published; sittings do not apply.

one of "live" | "async"

Per-attempt time limit in seconds; a live sitting's close still caps it.

fixed: every question in authored order, the same for everyone. shuffle: every question, order and options shuffled per attempt. random_draw: each bank link contributes draw_count randomly chosen questions (all when null), shuffled.

one of "fixed" | "shuffle" | "random_draw"

Score required to pass, as a percentage of the questions presented.

minimum 0 · maximum 100

Omit for unlimited attempts.

Defaults to true.

Defaults to false.

Question banks to link from the start, in presentation order; each must belong to the owning organization. Omit to link banks later via PUT /quizzes/{quiz_id}/banks.

at most 50 items