---
title: "Declare a profile field"
description: "\n\n### Quire permissions\n\nRequired capability: `profilefield/declare`.\n\nCredential scopes: `users: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 › users

`POST /profile_fields`

\### Quire permissions

Required capability: `profilefield/declare`.

Credential scopes: `users: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: `users:write`
- `oauth2`, oauth2, scopes: `users:write`

## Header parameters

- `createProfileField.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`
- `createProfileField.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._

- `createProfileField.entity` (string, required)
  - one of `"user"`, `"cohort"`
- `createProfileField.short_name` (string, required) — The key every restriction, cohort rule and report column names the field by. Fixed once created.
  - minLength 1; maxLength 63
- `createProfileField.kind` (string, required) — Fixed once created.
  - one of `"text"`, `"textarea"`, `"menu"`, `"checkbox"`, `"date"`, `"datetime"`, `"number"`, `"rich_text"`, `"url"`, `"social"`
- `createProfileField.name` (string, required)
  - minLength 1; maxLength 255
- `createProfileField.category` (any of, optional)
  - any of: `string`, `null`
- `createProfileField.visibility` (string, optional)
  - one of `"everyone"`, `"course_staff"`, `"managers"`, `"administrators"`, `"subject_only"`
- `createProfileField.required` (boolean, optional)
- `createProfileField.required_at_signup` (boolean, optional)
- `createProfileField.locked` (boolean, optional)
- `createProfileField.unique_values` (boolean, optional)
- `createProfileField.sort_order` (integer, optional)
  - min 0; max 100000
- `createProfileField.settings` (map<unknown>, optional) — Settings for the field kind, for example the options of a menu. Validated against the kind on write; never served by reads.
- `createProfileField.external_id` (string, optional)
  - minLength 1; maxLength 255

## Example request

```json
{
  "entity": "user",
  "short_name": "string",
  "kind": "text",
  "name": "string",
  "category": "string",
  "visibility": "everyone",
  "required": true,
  "required_at_signup": true,
  "locked": true,
  "unique_values": true,
  "sort_order": 100000,
  "settings": {
    "property1": null,
    "property2": null
  },
  "external_id": "string"
}
```

## Code samples

### cURL

```curl
curl --request POST \
  --url https://your-organisation.quirelms.com/api/v1/profile_fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity": "user",
  "short_name": "string",
  "kind": "text",
  "name": "string",
  "category": "string",
  "visibility": "everyone",
  "required": true,
  "required_at_signup": true,
  "locked": true,
  "unique_values": true,
  "sort_order": 100000,
  "settings": {
    "property1": null,
    "property2": null
  },
  "external_id": "string"
}
'
```

### TypeScript

```typescript
const url = 'https://your-organisation.quirelms.com/api/v1/profile_fields';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    entity: 'user',
    short_name: 'string',
    kind: 'text',
    name: 'string',
    category: 'string',
    visibility: 'everyone',
    required: true,
    required_at_signup: true,
    locked: true,
    unique_values: true,
    sort_order: 100000,
    settings: {property1: null, property2: null},
    external_id: 'string'
  })
};

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/profile_fields"

payload = {
    "entity": "user",
    "short_name": "string",
    "kind": "text",
    "name": "string",
    "category": "string",
    "visibility": "everyone",
    "required": True,
    "required_at_signup": True,
    "locked": True,
    "unique_values": True,
    "sort_order": 100000,
    "settings": {
        "property1": None,
        "property2": None
    },
    "external_id": "string"
}
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",
  "entity": "string",
  "short_name": "string",
  "name": "string",
  "description_key": "string",
  "kind": "string",
  "required": true,
  "required_at_signup": true,
  "visibility": "string",
  "locked": true,
  "sort_order": -9007199254740991,
  "category": "string",
  "unique_values": true,
  "created_at": "string",
  "updated_at": "string",
  "deleted_at": "string"
}
```

- `createProfileField.response.201.id` (string, required)
- `createProfileField.response.201.external_id` (string | null, required)
- `createProfileField.response.201.entity` (string, required)
- `createProfileField.response.201.short_name` (string, required)
- `createProfileField.response.201.name` (string, required)
- `createProfileField.response.201.description_key` (string | null, required)
- `createProfileField.response.201.kind` (string, required)
- `createProfileField.response.201.required` (boolean, required)
- `createProfileField.response.201.required_at_signup` (boolean, required)
- `createProfileField.response.201.visibility` (string, required)
- `createProfileField.response.201.locked` (boolean, required)
- `createProfileField.response.201.sort_order` (integer, required)
  - min -9007199254740991; max 9007199254740991
- `createProfileField.response.201.category` (string | null, required)
- `createProfileField.response.201.unique_values` (boolean, required)
- `createProfileField.response.201.created_at` (string, required) — RFC 3339 timestamp in UTC.
- `createProfileField.response.201.updated_at` (string, required) — RFC 3339 timestamp in UTC.
- `createProfileField.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"
}
```

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

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

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

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

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

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


Source: https://docs.quirelms.com/api/users/createProfileField/index.md