# Quiz Extensions

{% hint style="warning" %}
**Welcome to Our New API Docs!** This is the new home for all things API (previously at [Canvas LMS REST API Documentation](https://api.instructure.com)).
{% endhint %}

## Quiz Extensions API

API for setting extensions on student quiz submissions

**A QuizExtension object looks like:**

```js
{
  // The ID of the Quiz the quiz extension belongs to.
  "quiz_id": 2,
  // The ID of the Student that needs the quiz extension.
  "user_id": 3,
  // Number of times the student is allowed to re-take the quiz over the
  // multiple-attempt limit.
  "extra_attempts": 1,
  // Amount of extra time allowed for the quiz submission, in minutes.
  "extra_time": 60,
  // The student can take the quiz even if it's locked for everyone else
  "manually_unlocked": true,
  // The time at which the quiz submission will be overdue, and be flagged as a
  // late submission.
  "end_at": "2013-11-07T13:16:18Z"
}
```

### [Set extensions for student quiz submissions](#method.quizzes/quiz_extensions.create) <a href="#method.quizzes-quiz_extensions.create" id="method.quizzes-quiz_extensions.create"></a>

[Quizzes::QuizExtensionsController#create](https://github.com/instructure/canvas-lms/blob/master/app/controllers/quizzes/quiz_extensions_controller.rb)

**`POST /api/v1/courses/:course_id/quizzes/:quiz_id/extensions`**

**Scope:** `url:POST|/api/v1/courses/:course_id/quizzes/:quiz_id/extensions`

**Responses**

* **200 OK** if the request was successful
* **403 Forbidden** if you are not allowed to extend quizzes for this course

**Request Parameters:**

| Parameter                               | Type               | Description                                                                                                                                                                 |
| --------------------------------------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `quiz_extensions[][user_id]`            | Required `integer` | The ID of the user we want to add quiz extensions for.                                                                                                                      |
| `quiz_extensions[][extra_attempts]`     | `integer`          | Number of times the student is allowed to re-take the quiz over the multiple-attempt limit. This is limited to 1000 attempts or less.                                       |
| `quiz_extensions[][extra_time]`         | `integer`          | The number of extra minutes to allow for all attempts. This will add to the existing time limit on the submission. This is limited to 10080 minutes (1 week)                |
| `quiz_extensions[][manually_unlocked]`  | `boolean`          | Allow the student to take the quiz even if it’s locked for everyone else.                                                                                                   |
| `quiz_extensions[][extend_from_now]`    | `integer`          | The number of minutes to extend the quiz from the current time. This is mutually exclusive to extend\_from\_end\_at. This is limited to 1440 minutes (24 hours)             |
| `quiz_extensions[][extend_from_end_at]` | `integer`          | The number of minutes to extend the quiz beyond the quiz’s current ending time. This is mutually exclusive to extend\_from\_now. This is limited to 1440 minutes (24 hours) |

**Example Request:**

```bash
{
  "quiz_extensions": [{
    "user_id": 3,
    "extra_attempts": 2,
    "extra_time": 20,
    "manually_unlocked": true
  },{
    "user_id": 2,
    "extra_attempts": 2,
    "extra_time": 20,
    "manually_unlocked": false
  }]
}
```

```bash
{
  "quiz_extensions": [{
    "user_id": 3,
    "extend_from_now": 20
  }]
}
```

**Example Response:**

```js
{
  "quiz_extensions": [QuizExtension]
}
```

***

This documentation is generated directly from the Canvas LMS source code, available [on Github](https://github.com/instructure/canvas-lms).