## Update requisite preset

`PATCH /v1/requisite-presets/:id`

Updates fields of an existing requisite preset. Pass only the fields you want to change — the rest stay unchanged.

## Parameters

| Parameter | Type | Required | Description |
|----------|-----|:-----:|---------|
| `id` (path) | number | yes | Preset ID. List: `GET /v1/requisite-presets` |

## Request fields (body)

| Field | Type | Required | Description |
|------|-----|:-----:|---------|
| `name` | string | no | Preset name |
| `active` | boolean | no | Whether the preset is active |
| `sort` | number | no | Sort order |
| `xmlId` | string | no | External identifier for synchronization |

## Examples

### curl — personal key

```bash
curl -X PATCH "https://vibecode.bitrix24.com/v1/requisite-presets/31" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Organization (updated)",
    "sort": 999
  }'
```

### curl — OAuth app

```bash
curl -X PATCH "https://vibecode.bitrix24.com/v1/requisite-presets/31" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Organization (updated)"
  }'
```

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/requisite-presets/31', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Organization (updated)',
    sort: 999,
  }),
})

const { success, data } = await res.json()
```

### JavaScript — OAuth app

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/requisite-presets/31', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Organization (updated)',
  }),
})

const { success, data } = await res.json()
```

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | object | The updated preset with current field values |
| `data.id` | number | Preset identifier |
| `data.entityTypeId` | number | Field-set type — `8` |
| `data.countryId` | number | Field-set country ID |
| `data.name` | string | Preset name |
| `data.active` | boolean | Whether the preset is active |
| `data.sort` | number | Sort order |
| `data.xmlId` | string \| null | External identifier |
| `data.createdAt` | string | Creation date (ISO 8601) |
| `data.updatedAt` | string | Last update date (ISO 8601) |
| `data.createdBy` | number | Creator ID |
| `data.modifyBy` | number \| null | ID of the user who performed the update |

## Response example

```json
{
  "success": true,
  "data": {
    "id": 31,
    "entityTypeId": 8,
    "countryId": 1,
    "createdAt": "2026-06-10T09:31:49.000Z",
    "updatedAt": "2026-06-10T09:31:49.000Z",
    "createdBy": 1,
    "modifyBy": null,
    "name": "Organization (updated)",
    "xmlId": null,
    "active": true,
    "sort": 999
  }
}
```

## Error response example

404 — preset not found:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "The Preset with ID '999999' is not found"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 400 | `READONLY_FIELD` | A create-only field was sent — `countryId` or `entityTypeId`. In the [`GET /v1/requisite-presets/fields`](./fields.md) schema they are flagged `createOnly` |
| 404 | `ENTITY_NOT_FOUND` | No preset with this ID found |
| 422 | `BITRIX_ERROR` | Bitrix24 rejected the value of one of the fields |
| 403 | `SCOPE_DENIED` | API key lacks the `crm` scope |
| 401 | `TOKEN_MISSING` | API key has no configured tokens |

Full list of common API errors — [Errors](/docs/errors).

## Known specifics

**The `entityTypeId` and `countryId` fields are set only at creation.** In the [`GET /v1/requisite-presets/fields`](./fields.md) schema they come with a `createOnly` flag and `readonly: false` — they are writable, but only in the create body. Sending either of them in the update body is rejected with `400 READONLY_FIELD`. To use a different country, create a new preset.

## See also

- [Get preset](/docs/entities/requisite-presets/get)
- [List presets](/docs/entities/requisite-presets/list)
- [Delete preset](/docs/entities/requisite-presets/delete)
- [Preset fields](/docs/entities/requisite-presets/fields)
- [Batch](/docs/batch)