Create Exam - Plugixa Exam

POST /plugixa-exam/v1/exams

Create an exam, with its settings and, optionally, its sections and questions in one call.

Scope exams:write; the token’s user needs the exams:create permission. Creating it already published also needs the exams:publish scope and the user’s exams:publish permission.

Note. An exam created without published is unpublished. Sending "published": true publishes it at once, which needs exams:publish as well; without it the request answers 403 and nothing is created. Since 1.4.1: before, exams:write alone could publish.

Request

POST https://your-site.example/wp-json/plugixa-exam/v1/exams

Request body

Content type: application/json

Only title is required. Every other field has a default, and an enumerated field sent with a value outside its list quietly takes its default instead of failing. “Site default” means the value set under Plugixa Exam -> Settings; the default shown in brackets is the one a new install starts with.

Basics

Timing and attempts

Who may sit it

Results

The paper

Unfinished attempts

Sections, settings and custom fields

Each section:

The settings keys lms_provider, lms_course_id, lms_step_id and lms_completes_course link the exam to an LMS course PRO, and are checked when the LMS Bridge app is on.

{
  "title": "Algebra Midterm",
  "description": "Linear equations and inequalities.",
  "intro": "<p>You have 45 minutes. Calculators are allowed.</p>",
  "subject_id": 12,
  "time_limit": 45,
  "max_attempts": 2,
  "cooldown_minutes": 60,
  "open_from": "2026-11-16 08:00:00",
  "open_until": "2026-11-20 18:00:00",
  "pass_mark": 60,
  "shuffle_questions": true,
  "access_type": "code",
  "access_code": "ALG-2026",
  "result_release": "after_close",
  "pass_message": "<p>Well done, you passed.</p>",
  "layout": "one_per_page",
  "sections": [
    {
      "title": "Part A",
      "section_type": "fixed",
      "questions": [41, { "question_id": 42, "points": 2 }]
    },
    {
      "title": "Part B",
      "section_type": "pool",
      "points_per_question": 1,
      "rules": [
        { "subject_id": 15, "question_type": "mcq_single", "draw_count": 5 }
      ]
    }
  ]
}

Responses

201 Created. data is the new exam, with its sections.

{
  "success": true,
  "data": {
    "id": 7,
    "title": "Algebra Midterm",
    "slug": "algebra-midterm",
    "description": "Linear equations and inequalities.",
    "intro": "<p>You have 45 minutes. Calculators are allowed.</p>",
    "subject_id": 12,
    "time_limit": 45,
    "max_attempts": 2,
    "cooldown_minutes": 60,
    "open_from": "2026-11-16 08:00:00",
    "open_until": "2026-11-20 18:00:00",
    "pass_mark": 60,
    "shuffle_questions": true,
    "shuffle_options": false,
    "access_type": "code",
    "access_level": null,
    "result_release": "after_close",
    "release_at": null,
    "show_answers": true,
    "pass_message": "<p>Well done, you passed.</p>",
    "fail_message": "",
    "lock_policy": "auto",
    "attempt_mode": "exam",
    "practice_reveal": "on_submit",
    "layout": "one_per_page",
    "review_before_submit": true,
    "allow_early_finish": true,
    "fullscreen_mode": "off",
    "require_answer": "off",
    "allow_pause": false,
    "max_pauses": 0,
    "max_pause_minutes": 0,
    "auto_close_action": "submit",
    "idle_timeout_minutes": 1440,
    "window_close_action": "close",
    "auto_close_held": false,
    "auto_close_time_spent": "capped",
    "auto_close_notify": "auto",
    "track_integrity": true,
    "certificate_template_id": 0,
    "settings": null,
    "custom_fields": null,
    "published": false,
    "created_at": "2026-11-12 09:30:00",
    "modified_at": "2026-11-12 09:30:00",
    "created_by": 1,
    "modified_by": 1,
    "deleted_at": null,
    "sections": [
      {
        "id": 21,
        "exam_id": 7,
        "title": "Part A",
        "description": "",
        "ordering": 1,
        "section_type": "fixed",
        "points_per_question": null,
        "questions": [
          { "id": 101, "exam_id": "7", "section_id": 21, "question_id": 41, "ordering": 1, "points": null },
          { "id": 102, "exam_id": "7", "section_id": 21, "question_id": 42, "ordering": 2, "points": 2 }
        ],
        "rules": []
      },
      {
        "id": 22,
        "exam_id": 7,
        "title": "Part B",
        "description": "",
        "ordering": 2,
        "section_type": "pool",
        "points_per_question": 1,
        "questions": [],
        "rules": [
          {
            "id": 9,
            "section_id": 22,
            "subject_id": 15,
            "difficulty": null,
            "question_type": "mcq_single",
            "draw_count": 5,
            "points_per_question": null,
            "tag_ids": []
          }
        ]
      }
    ],
    "has_access_code": true
  }
}

Errors

Plus the errors every endpoint can return.

Examples

curl -s -X POST "https://your-site.example/wp-json/plugixa-exam/v1/exams" \
  -H "Authorization: Bearer $PLUGIXA_EXAM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Algebra Midterm","subject_id":12,"time_limit":45,"pass_mark":60,"access_type":"code","access_code":"ALG-2026","sections":[{"title":"Part A","questions":[41,{"question_id":42,"points":2}]}]}'

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-exam/v1/exams');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer ' . getenv('PLUGIXA_EXAM_TOKEN'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => json_encode([
        'title'       => 'Algebra Midterm',
        'subject_id'  => 12,
        'time_limit'  => 45,
        'pass_mark'   => 60,
        'access_type' => 'code',
        'access_code' => 'ALG-2026',
        'sections'    => [
            [
                'title'     => 'Part A',
                'questions' => [41, ['question_id' => 42, 'points' => 2]],
            ],
        ],
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const response = await fetch('https://your-site.example/wp-json/plugixa-exam/v1/exams', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.PLUGIXA_EXAM_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Algebra Midterm',
    subject_id: 12,
    time_limit: 45,
    pass_mark: 60,
    access_type: 'code',
    access_code: 'ALG-2026',
    sections: [
      { title: 'Part A', questions: [41, { question_id: 42, points: 2 }] },
    ],
  }),
});
const { data } = await response.json();