---
title: "Create a question"
description: "\n\n### Quire permissions\n\nCredential scopes: `questions:write`.\n\nThe acting subject must also be allowed to perform this action in the organisation."
image: "https://docs.quirelms.com/og.png"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.quirelms.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Quire API › questions

`POST /questions`

\### Quire permissions

Credential scopes: `questions:write`.

The acting subject must also be allowed to perform this action in the organisation.

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`, scopes: `questions:write`
- `oauth2`, oauth2, scopes: `questions:write`

## Header parameters

- `createQuestion.header.Quire-Version` (string, optional) — The dated API revision to serve this request at. Omitted, the request is served at the revision the credential was issued against. The response echoes the revision actually applied.
  - format `date`
- `createQuestion.header.Idempotency-Key` (string, optional) — A caller-chosen key making this request safe to retry. A replay of a completed request returns the recorded response with `Idempotency-Replayed: true`. Reusing a key for a different request is refused.
  - maxLength 255

## Request body

_Required._

- `createQuestion.name` (string, required)
  - minLength 1; maxLength 255
- `createQuestion.stem` (object, required)
  - `createQuestion.stem.type` (string, required)
- `createQuestion.general_feedback` (any of, required)
  - default `null`
  - any of: `Option 1`, `null`
- `createQuestion.default_mark` (number, required)
  - min 0
- `createQuestion.penalty` (number, required)
  - min 0; max 1
- `createQuestion.payload` (unknown, required)
- `createQuestion.bank_id` (string, required)
  - format `uuid`; pattern `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$`
- `createQuestion.category_id` (string, required)
  - format `uuid`; pattern `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$`
- `createQuestion.qtype` (string, required)
  - one of `"multichoice"`, `"truefalse"`, `"shortanswer"`, `"numerical"`, `"calculated"`, `"calculatedsimple"`, `"calculatedmulti"`, `"essay"`, `"matching"`, `"randomsamatch"`, `"multianswer"`, `"ddwtos"`, `"ddimageortext"`, `"ddmarker"`, `"gapselect"`, `"ordering"`, `"description"`, `"hotspot"`, `"code"`
- `createQuestion.hints` (array<object>, optional)
  - `createQuestion.hints.text` (unknown, required)
  - `createQuestion.hints.clearWrong` (boolean, required)
  - `createQuestion.hints.showNumCorrect` (boolean, required)
- `createQuestion.status` (string, optional)
  - one of `"draft"`, `"ready"`
- `createQuestion.id_number` (any of, optional)
  - any of: `string`, `null`
- `createQuestion.external_id` (string, optional)
  - minLength 1; maxLength 255

## Example request

```json
{
  "name": "string",
  "stem": {
    "type": "doc",
    "property1": null,
    "property2": null
  },
  "general_feedback": null,
  "default_mark": 0,
  "penalty": 1,
  "hints": [
    {
      "text": null,
      "clearWrong": true,
      "showNumCorrect": true
    }
  ],
  "payload": null,
  "status": "draft",
  "id_number": "string",
  "external_id": "string",
  "bank_id": "f1ae96de-94c1-468e-93a3-6b7213930ca8",
  "category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
  "qtype": "multichoice"
}
```

## Code samples

### cURL

```curl
curl --request POST \
  --url https://your-organisation.quirelms.com/api/v1/questions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "string",
  "stem": {
    "type": "doc",
    "property1": null,
    "property2": null
  },
  "general_feedback": null,
  "default_mark": 0,
  "penalty": 1,
  "hints": [
    {
      "text": null,
      "clearWrong": true,
      "showNumCorrect": true
    }
  ],
  "payload": null,
  "status": "draft",
  "id_number": "string",
  "external_id": "string",
  "bank_id": "f1ae96de-94c1-468e-93a3-6b7213930ca8",
  "category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
  "qtype": "multichoice"
}
'
```

### TypeScript

```typescript
const url = 'https://your-organisation.quirelms.com/api/v1/questions';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    name: 'string',
    stem: {type: 'doc', property1: null, property2: null},
    general_feedback: null,
    default_mark: 0,
    penalty: 1,
    hints: [{text: null, clearWrong: true, showNumCorrect: true}],
    payload: null,
    status: 'draft',
    id_number: 'string',
    external_id: 'string',
    bank_id: 'f1ae96de-94c1-468e-93a3-6b7213930ca8',
    category_id: '8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2',
    qtype: 'multichoice'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://your-organisation.quirelms.com/api/v1/questions"

payload = {
    "name": "string",
    "stem": {
        "type": "doc",
        "property1": None,
        "property2": None
    },
    "general_feedback": None,
    "default_mark": 0,
    "penalty": 1,
    "hints": [
        {
            "text": None,
            "clearWrong": True,
            "showNumCorrect": True
        }
    ],
    "payload": None,
    "status": "draft",
    "id_number": "string",
    "external_id": "string",
    "bank_id": "f1ae96de-94c1-468e-93a3-6b7213930ca8",
    "category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
    "qtype": "multichoice"
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 201

Success.

#### Example

```json
{
  "id": "string",
  "external_id": "string",
  "bank_id": "string",
  "category_id": "string",
  "qtype": "string",
  "latest_version_id": "string",
  "ready_version_id": "string",
  "id_number": "string",
  "created_by": "string",
  "created_at": "string",
  "updated_at": "string",
  "deleted_at": "string"
}
```

- `createQuestion.response.201.id` (string, required)
- `createQuestion.response.201.external_id` (string | null, required)
- `createQuestion.response.201.bank_id` (string, required)
- `createQuestion.response.201.category_id` (string, required)
- `createQuestion.response.201.qtype` (string, required)
- `createQuestion.response.201.latest_version_id` (string | null, required)
- `createQuestion.response.201.ready_version_id` (string | null, required)
- `createQuestion.response.201.id_number` (string | null, required)
- `createQuestion.response.201.created_by` (string, required)
- `createQuestion.response.201.created_at` (string, required) — RFC 3339 timestamp in UTC.
- `createQuestion.response.201.updated_at` (string, required) — RFC 3339 timestamp in UTC.
- `createQuestion.response.201.deleted_at` (any of, required)
  - any of: `string`, `null`

### 401

The credential is missing, malformed, expired or revoked.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `createQuestion.response.401.type` (string, required)
  - format `uri`
- `createQuestion.response.401.title` (string, required)
- `createQuestion.response.401.status` (integer, required)
- `createQuestion.response.401.code` (string, required)
- `createQuestion.response.401.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `createQuestion.response.401.detail` (string, required)
- `createQuestion.response.401.request_id` (string, required)
- `createQuestion.response.401.docs_url` (string, required)
  - format `uri`
- `createQuestion.response.401.errors` (array<object>, optional)
  - `createQuestion.response.401.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `createQuestion.response.401.errors.code` (string, required)
  - `createQuestion.response.401.errors.detail` (string, required)
- `createQuestion.response.401.retry_after` (integer | null, optional)

### 403

The credential lacks the scope this operation requires, or the acting subject lacks the capability.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `createQuestion.response.403.type` (string, required)
  - format `uri`
- `createQuestion.response.403.title` (string, required)
- `createQuestion.response.403.status` (integer, required)
- `createQuestion.response.403.code` (string, required)
- `createQuestion.response.403.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `createQuestion.response.403.detail` (string, required)
- `createQuestion.response.403.request_id` (string, required)
- `createQuestion.response.403.docs_url` (string, required)
  - format `uri`
- `createQuestion.response.403.errors` (array<object>, optional)
  - `createQuestion.response.403.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `createQuestion.response.403.errors.code` (string, required)
  - `createQuestion.response.403.errors.detail` (string, required)
- `createQuestion.response.403.retry_after` (integer | null, optional)

### 409

The request conflicts with the current state, with a previous use of the same idempotency key, or with a concurrent write.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `createQuestion.response.409.type` (string, required)
  - format `uri`
- `createQuestion.response.409.title` (string, required)
- `createQuestion.response.409.status` (integer, required)
- `createQuestion.response.409.code` (string, required)
- `createQuestion.response.409.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `createQuestion.response.409.detail` (string, required)
- `createQuestion.response.409.request_id` (string, required)
- `createQuestion.response.409.docs_url` (string, required)
  - format `uri`
- `createQuestion.response.409.errors` (array<object>, optional)
  - `createQuestion.response.409.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `createQuestion.response.409.errors.code` (string, required)
  - `createQuestion.response.409.errors.detail` (string, required)
- `createQuestion.response.409.retry_after` (integer | null, optional)

### 422

The request was understood and its content is not valid. `errors` names each field.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `createQuestion.response.422.type` (string, required)
  - format `uri`
- `createQuestion.response.422.title` (string, required)
- `createQuestion.response.422.status` (integer, required)
- `createQuestion.response.422.code` (string, required)
- `createQuestion.response.422.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `createQuestion.response.422.detail` (string, required)
- `createQuestion.response.422.request_id` (string, required)
- `createQuestion.response.422.docs_url` (string, required)
  - format `uri`
- `createQuestion.response.422.errors` (array<object>, optional)
  - `createQuestion.response.422.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `createQuestion.response.422.errors.code` (string, required)
  - `createQuestion.response.422.errors.detail` (string, required)
- `createQuestion.response.422.retry_after` (integer | null, optional)

### 429

A rate limit or a concurrency cap was reached. `Retry-After` says when to try again.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `createQuestion.response.429.type` (string, required)
  - format `uri`
- `createQuestion.response.429.title` (string, required)
- `createQuestion.response.429.status` (integer, required)
- `createQuestion.response.429.code` (string, required)
- `createQuestion.response.429.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `createQuestion.response.429.detail` (string, required)
- `createQuestion.response.429.request_id` (string, required)
- `createQuestion.response.429.docs_url` (string, required)
  - format `uri`
- `createQuestion.response.429.errors` (array<object>, optional)
  - `createQuestion.response.429.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `createQuestion.response.429.errors.code` (string, required)
  - `createQuestion.response.429.errors.detail` (string, required)
- `createQuestion.response.429.retry_after` (integer | null, optional)

### 500

Something failed at our end. Quote `request_id` when reporting it.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `createQuestion.response.500.type` (string, required)
  - format `uri`
- `createQuestion.response.500.title` (string, required)
- `createQuestion.response.500.status` (integer, required)
- `createQuestion.response.500.code` (string, required)
- `createQuestion.response.500.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `createQuestion.response.500.detail` (string, required)
- `createQuestion.response.500.request_id` (string, required)
- `createQuestion.response.500.docs_url` (string, required)
  - format `uri`
- `createQuestion.response.500.errors` (array<object>, optional)
  - `createQuestion.response.500.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `createQuestion.response.500.errors.code` (string, required)
  - `createQuestion.response.500.errors.detail` (string, required)
- `createQuestion.response.500.retry_after` (integer | null, optional)


Source: https://docs.quirelms.com/api/questions/createQuestion/index.md