---
title: "Create or update an enrolment method by external identifier"
description: "The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile.\n\n### Quire permissions\n\nRequired capability: `enrol/configure_method`.\n\nCredential scopes: `enrolments: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 › enrolments

`PUT /enrolment_methods/ext:{external_id}`

The body is the full representation: null clears a field, an absent field is left alone. Answers 201 when the row was created and 200 when it was updated, which is how a system of record tells a create from a reconcile.

\### Quire permissions

Required capability: `enrol/configure_method`.

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

## Path parameters

- `upsertEnrolmentMethod.path.external_id` (string, required) — The external identifier, unique per tenant per type, as supplied by the system of record.

## Header parameters

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

- `upsertEnrolmentMethod.course_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)$`
- `upsertEnrolmentMethod.preset` (string, required) — The method to add: manual, self, approval, payment, waitlist, seats, cohort_sync, meta, guest, category, automation, api, external_db, hubspot, ims_enterprise, oneroster or lti.
  - minLength 1; maxLength 40
- `upsertEnrolmentMethod.name` (any of, optional)
  - any of: `string`, `null`
- `upsertEnrolmentMethod.default_role_id` (string, optional) — A course role other than the method default.
  - 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)$`
- `upsertEnrolmentMethod.enrol_start_at` (any of, optional)
  - any of: `string`, `null`
- `upsertEnrolmentMethod.enrol_end_at` (any of, optional)
  - any of: `string`, `null`
- `upsertEnrolmentMethod.enrol_period_days` (any of, optional)
  - any of: `integer`, `null`
- `upsertEnrolmentMethod.max_enrolled` (any of, optional)
  - any of: `integer`, `null`
- `upsertEnrolmentMethod.on_source_removal` (string, optional)
  - one of `"suspend"`, `"suspend_and_unassign"`, `"unenrol"`
- `upsertEnrolmentMethod.enrolment_key` (any of, optional) — Self enrolment: a new key, or null to remove it. Write-only: it is never returned.
  - any of: `string`, `null`
- `upsertEnrolmentMethod.group_keys` (array<object>, optional) — Self enrolment: a key per group. Write-only: never returned.
  - `upsertEnrolmentMethod.group_keys.group_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)$`
  - `upsertEnrolmentMethod.group_keys.key` (string, required)
    - minLength 4; maxLength 200
- `upsertEnrolmentMethod.guest_password` (any of, optional) — Guest access: a new password, or null to remove it. Write-only: never returned.
  - any of: `string`, `null`
- `upsertEnrolmentMethod.allow_forum_read` (boolean, optional)
- `upsertEnrolmentMethod.source_key` (string, optional) — The cohort, course or category a source-following method follows.
  - maxLength 500
- `upsertEnrolmentMethod.source_role_id` (any of, optional)
  - any of: `string`, `null`
- `upsertEnrolmentMethod.include_subcategories` (boolean, optional)
- `upsertEnrolmentMethod.approval_role_id` (any of, optional)
  - any of: `string`, `null`
- `upsertEnrolmentMethod.approval_expiry_days` (integer, optional)
  - min 1; max 365
- `upsertEnrolmentMethod.capacity` (integer, optional)
  - min 1; max 9007199254740991
- `upsertEnrolmentMethod.seat_pool_id` (string, optional)
  - 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)$`
- `upsertEnrolmentMethod.price_id` (string, optional)
  - 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)$`
- `upsertEnrolmentMethod.external` (map<string>, optional) — Settings of an externally fed method. Write-only.

## Example request

```json
{
  "course_id": "5e757794-c815-4ccc-bf16-1010d8ef2347",
  "preset": "string",
  "name": "string",
  "default_role_id": "f16726e8-3b54-4d9b-a01f-a76d5a80658c",
  "enrol_start_at": "2019-08-24T14:15:22Z",
  "enrol_end_at": "2019-08-24T14:15:22Z",
  "enrol_period_days": 1,
  "max_enrolled": 1,
  "on_source_removal": "suspend",
  "enrolment_key": "string",
  "group_keys": [
    {
      "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
      "key": "string"
    }
  ],
  "guest_password": "string",
  "allow_forum_read": true,
  "source_key": "string",
  "source_role_id": "c9466ded-21b1-46a5-a0d1-1491d3d46740",
  "include_subcategories": true,
  "approval_role_id": "1c3af314-4fb4-495c-a142-607b2c7e6438",
  "approval_expiry_days": 1,
  "capacity": 1,
  "seat_pool_id": "4b2ff627-9c14-4c19-87f7-01fa2222b3df",
  "price_id": "5eff5d89-979e-4e4f-aa76-6cbbbf11362c",
  "external": {
    "property1": "string",
    "property2": "string"
  }
}
```

## Code samples

### cURL

```curl
curl --request PUT \
  --url https://your-organisation.quirelms.com/api/v1/enrolment_methods/ext:string \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "course_id": "5e757794-c815-4ccc-bf16-1010d8ef2347",
  "preset": "string",
  "name": "string",
  "default_role_id": "f16726e8-3b54-4d9b-a01f-a76d5a80658c",
  "enrol_start_at": "2019-08-24T14:15:22Z",
  "enrol_end_at": "2019-08-24T14:15:22Z",
  "enrol_period_days": 1,
  "max_enrolled": 1,
  "on_source_removal": "suspend",
  "enrolment_key": "string",
  "group_keys": [
    {
      "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
      "key": "string"
    }
  ],
  "guest_password": "string",
  "allow_forum_read": true,
  "source_key": "string",
  "source_role_id": "c9466ded-21b1-46a5-a0d1-1491d3d46740",
  "include_subcategories": true,
  "approval_role_id": "1c3af314-4fb4-495c-a142-607b2c7e6438",
  "approval_expiry_days": 1,
  "capacity": 1,
  "seat_pool_id": "4b2ff627-9c14-4c19-87f7-01fa2222b3df",
  "price_id": "5eff5d89-979e-4e4f-aa76-6cbbbf11362c",
  "external": {
    "property1": "string",
    "property2": "string"
  }
}
'
```

### TypeScript

```typescript
const url = 'https://your-organisation.quirelms.com/api/v1/enrolment_methods/ext:string';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    course_id: '5e757794-c815-4ccc-bf16-1010d8ef2347',
    preset: 'string',
    name: 'string',
    default_role_id: 'f16726e8-3b54-4d9b-a01f-a76d5a80658c',
    enrol_start_at: '2019-08-24T14:15:22Z',
    enrol_end_at: '2019-08-24T14:15:22Z',
    enrol_period_days: 1,
    max_enrolled: 1,
    on_source_removal: 'suspend',
    enrolment_key: 'string',
    group_keys: [{group_id: '306db4e0-7449-4501-b76f-075576fe2d8f', key: 'string'}],
    guest_password: 'string',
    allow_forum_read: true,
    source_key: 'string',
    source_role_id: 'c9466ded-21b1-46a5-a0d1-1491d3d46740',
    include_subcategories: true,
    approval_role_id: '1c3af314-4fb4-495c-a142-607b2c7e6438',
    approval_expiry_days: 1,
    capacity: 1,
    seat_pool_id: '4b2ff627-9c14-4c19-87f7-01fa2222b3df',
    price_id: '5eff5d89-979e-4e4f-aa76-6cbbbf11362c',
    external: {property1: 'string', property2: '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/enrolment_methods/ext:string"

payload = {
    "course_id": "5e757794-c815-4ccc-bf16-1010d8ef2347",
    "preset": "string",
    "name": "string",
    "default_role_id": "f16726e8-3b54-4d9b-a01f-a76d5a80658c",
    "enrol_start_at": "2019-08-24T14:15:22Z",
    "enrol_end_at": "2019-08-24T14:15:22Z",
    "enrol_period_days": 1,
    "max_enrolled": 1,
    "on_source_removal": "suspend",
    "enrolment_key": "string",
    "group_keys": [
        {
            "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
            "key": "string"
        }
    ],
    "guest_password": "string",
    "allow_forum_read": True,
    "source_key": "string",
    "source_role_id": "c9466ded-21b1-46a5-a0d1-1491d3d46740",
    "include_subcategories": True,
    "approval_role_id": "1c3af314-4fb4-495c-a142-607b2c7e6438",
    "approval_expiry_days": 1,
    "capacity": 1,
    "seat_pool_id": "4b2ff627-9c14-4c19-87f7-01fa2222b3df",
    "price_id": "5eff5d89-979e-4e4f-aa76-6cbbbf11362c",
    "external": {
        "property1": "string",
        "property2": "string"
    }
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

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

print(response.text)
```

## Responses

### 200

Success.

#### Example

```json
{
  "id": "string",
  "external_id": "string",
  "course_id": "string",
  "kind": "string",
  "name": "string",
  "enabled": true,
  "sort_order": -9007199254740991,
  "default_role_id": "string",
  "enrol_start_at": "string",
  "enrol_end_at": "string",
  "max_enrolled": -9007199254740991,
  "created_at": "string",
  "updated_at": "string",
  "deleted_at": "string"
}
```

- `upsertEnrolmentMethod.response.200.id` (string, required)
- `upsertEnrolmentMethod.response.200.external_id` (string | null, required)
- `upsertEnrolmentMethod.response.200.course_id` (string, required)
- `upsertEnrolmentMethod.response.200.kind` (string, required)
- `upsertEnrolmentMethod.response.200.name` (string | null, required)
- `upsertEnrolmentMethod.response.200.enabled` (boolean, required)
- `upsertEnrolmentMethod.response.200.sort_order` (integer, required)
  - min -9007199254740991; max 9007199254740991
- `upsertEnrolmentMethod.response.200.default_role_id` (string, required)
- `upsertEnrolmentMethod.response.200.enrol_start_at` (any of, required)
  - any of: `string`, `null`
- `upsertEnrolmentMethod.response.200.enrol_end_at` (any of, required)
  - any of: `string`, `null`
- `upsertEnrolmentMethod.response.200.max_enrolled` (any of, required)
  - any of: `integer`, `null`
- `upsertEnrolmentMethod.response.200.created_at` (string, required) — RFC 3339 timestamp in UTC.
- `upsertEnrolmentMethod.response.200.updated_at` (string, required) — RFC 3339 timestamp in UTC.
- `upsertEnrolmentMethod.response.200.deleted_at` (any of, required)
  - any of: `string`, `null`

### 201

Success.

#### Example

```json
{
  "id": "string",
  "external_id": "string",
  "course_id": "string",
  "kind": "string",
  "name": "string",
  "enabled": true,
  "sort_order": -9007199254740991,
  "default_role_id": "string",
  "enrol_start_at": "string",
  "enrol_end_at": "string",
  "max_enrolled": -9007199254740991,
  "created_at": "string",
  "updated_at": "string",
  "deleted_at": "string"
}
```

- `upsertEnrolmentMethod.response.201.id` (string, required)
- `upsertEnrolmentMethod.response.201.external_id` (string | null, required)
- `upsertEnrolmentMethod.response.201.course_id` (string, required)
- `upsertEnrolmentMethod.response.201.kind` (string, required)
- `upsertEnrolmentMethod.response.201.name` (string | null, required)
- `upsertEnrolmentMethod.response.201.enabled` (boolean, required)
- `upsertEnrolmentMethod.response.201.sort_order` (integer, required)
  - min -9007199254740991; max 9007199254740991
- `upsertEnrolmentMethod.response.201.default_role_id` (string, required)
- `upsertEnrolmentMethod.response.201.enrol_start_at` (any of, required)
  - any of: `string`, `null`
- `upsertEnrolmentMethod.response.201.enrol_end_at` (any of, required)
  - any of: `string`, `null`
- `upsertEnrolmentMethod.response.201.max_enrolled` (any of, required)
  - any of: `integer`, `null`
- `upsertEnrolmentMethod.response.201.created_at` (string, required) — RFC 3339 timestamp in UTC.
- `upsertEnrolmentMethod.response.201.updated_at` (string, required) — RFC 3339 timestamp in UTC.
- `upsertEnrolmentMethod.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"
}
```

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

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

### 404

No such resource, or none this credential is permitted to know about.

#### 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"
}
```

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

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

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

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

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


Source: https://docs.quirelms.com/api/enrolments/upsertEnrolmentMethod/index.md