UpdateQuizQuestionRequest

A request or response body; the type column links to the schemas it refers to.

UpdateQuizQuestionRequest

FieldTypeRequiredDescription
promptstringno

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

prompt_formatstringno

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"

prompt_pdfanyno—
prompt_pdf_prefer_inline_displaybooleanno

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.

explanationstring | nullno

Send null to clear the explanation.

at most 2000 characters

pointsintegerno

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

minimum 1 · maximum 1000

requires_manual_gradingbooleanno

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

rubric_markdownstring | nullno

Send null or empty to clear the rubric.

at most 50000 characters

rubric_visible_to_takersbooleanno

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

correct_booleanbooleanno

For true_false questions only.

correct_numbernumberno

numeric questions only.

tolerancenumberno

numeric questions only; 0 demands the exact value.

minimum 0

optionsarray of objectno

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_starting_imagestring | nullno

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+/]+=*$

jsonExample
{
  "prompt": "string",
  "prompt_format": "plaintext",
  "prompt_pdf": null,
  "prompt_pdf_prefer_inline_display": true,
  "explanation": "string",
  "points": 1,
  "requires_manual_grading": true,
  "rubric_markdown": "- 2 points: names both hazards\n- 1 point: names one\n- 0: neither",
  "rubric_visible_to_takers": true,
  "correct_boolean": true,
  "correct_number": 42,
  "tolerance": 0.5,
  "options": [
    {
      "label": "string",
      "is_correct": true,
      "match_label": "string",
      "blank_index": 0
    }
  ],
  "drawing_starting_image": "data:image/png;base64,iVBORw0KGgo…"
}