Developers
Exams

Create an exam question

POST/products/{product_id}/exams/{exam_id}/questions

Adds a question to the exam.

The question must have at least two alternatives, and at least one of them must be marked as correct. Questions are single-choice: if more than one alternative is marked as correct, only the first one is treated as correct.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

product_id*string
exam_id*string

Header Parameters

Idempotency-Key*string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. Repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/products/string/exams/string/questions" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "alternatives": [      {        "text": "string"      },      {        "text": "string"      }    ],    "format": "multiple_choice",    "text": "string"  }'
{  "data": {    "alternatives": [      {        "correct": true,        "id": "string",        "text": "string"      }    ],    "created_at": "2019-08-24T14:15:22Z",    "deleted": true,    "exam_id": "string",    "format": "multiple_choice",    "id": "string",    "image": "string",    "object": "exam_question",    "position": 0,    "revision": "string",    "text": "string",    "updated_at": "2019-08-24T14:15:22Z"  }}

List exam questions GET

The `correct` field of each alternative is included only when the current credentials have the `exams.read_answer_key` permission; otherwise, the field is omitted.

Reorder exam questions PUT

Sets the order in which the exam questions are presented. The request must contain exactly the set of questions currently in the exam, excluding questions in the trash. If the supplied set does not match, the request is rejected with `order_set_mismatch` and the existing order remains unchanged. To avoid overwriting a newer version, send the exam `ETag` from the exam retrieve operation in the `If-Match` header.