
## Update requisite

`PATCH /v1/requisites/:id`

Updates fields of an existing requisite. Pass fields at the root of the request body, without a `fields` wrapper.

## Parameters

| Parameter | Type | Required | Description |
|----------|-----|:-----:|---------|
| `id` (path) | number | yes | Requisite ID. List: [`GET /v1/requisites`](/docs/entities/requisites/list) |

## Request fields (body)

Pass only the fields you want to change (at least one). All fields are optional. Below are the common fields and a selection of `rq*` fields. The fields a preset uses are listed by [`GET /v1/requisite-presets/:presetId/fields`](/docs/entities/requisite-presets/preset-fields/list). Full list, including fields of all countries and `UF_CRM_*` user fields — [`GET /v1/requisites/fields`](/docs/entities/requisites/fields).

| Field | Type | Description |
|------|-----|---------|
| `name` | string | Requisite name in the Bitrix24 interface |
| `active` | boolean | Whether the requisite is active |
| `sort` | number | Sort order. Lower values come first |
| `code` | string | Symbolic code for external integrations |
| `xmlId` | string | External identifier for synchronization |
| `originatorId` | string | Source system ID |
| `addressOnly` | boolean | "Address only" flag |
| `rqName` | string | Full name |
| `rqCompanyName` | string | Short legal-entity name |
| `rqCompanyFullName` | string | Full legal-entity name |
| `rqInn` | string | INN |
| `rqKpp` | string | KPP |
| `rqOgrn` | string | OGRN |
| `rqDirector` | string | Director's full name |
| `rqAccountant` | string | Chief accountant's full name |
| `rqVatPayer` | boolean | VAT payer |
| `UF_CRM_*` | depends on the field | Requisite user field. Names and types are listed in [`GET /v1/requisites/fields`](/docs/entities/requisites/fields) |
| `id`, `createdAt`, `updatedAt`, `createdBy`, `modifyBy` | RO | Set by the system. Passing them is rejected with `400 READONLY_FIELD` |

## Examples

### curl — personal key

```bash
curl -X PATCH "https://vibecode.bitrix24.com/v1/requisites/42" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "rqInn": "1234567890",
    "rqKpp": "123456789",
    "rqDirector": "John Smith"
  }'
```

### curl — OAuth application

```bash
curl -X PATCH "https://vibecode.bitrix24.com/v1/requisites/42" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "rqInn": "1234567890",
    "rqKpp": "123456789"
  }'
```

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/requisites/42', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    rqInn: '1234567890',
    rqKpp: '123456789',
    rqDirector: 'John Smith',
  }),
})

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

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/requisites/42', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    rqInn: '1234567890',
    rqKpp: '123456789',
  }),
})

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

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | `true` on success |
| `data` | object | The updated requisite. Contains all requisite fields, including unchanged ones and `UF_CRM_*` user fields. Empty fields are `null`. Field reference — [Requisite fields](/docs/entities/requisites/fields) |
| `data.id` | number | Requisite ID |
| `data.updatedAt` | datetime | Modification date after the update |
| `data.modifyBy` | number | ID of the user who performed the update |

## Response example

The main fields are shown. Full list: [Requisite fields](/docs/entities/requisites/fields).

```json
{
  "success": true,
  "data": {
    "id": 527,
    "entityTypeId": 4,
    "entityId": 3157,
    "presetId": 1,
    "name": "Primary requisite",
    "active": true,
    "sort": 500,
    "rqInn": "1234567890",
    "rqKpp": "123456789",
    "rqDirector": "John Smith",
    "createdAt": "2026-10-22T08:51:53.000Z",
    "updatedAt": "2026-10-22T08:53:26.000Z",
    "modifyBy": 1
  }
}
```

## Error response example

404 — requisite not found:

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

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 404 | `ENTITY_NOT_FOUND` | No requisite with this `id` |
| 400 | `EMPTY_UPDATE_BODY` | The request body is empty |
| 400 | `READONLY_FIELD` | A read-only field was passed: `id`, `createdAt`, `updatedAt`, `createdBy`, `modifyBy` |
| 400 | `INVALID_PARAMS` | The value does not match the field type, for example the string `"abc"` in `sort` or an empty string in `active` |
| 400 | `NESTED_FIELDS_ENVELOPE` | Fields were passed inside a `fields` object instead of at the root of the body |
| 403 | `BITRIX_ACCESS_DENIED` | No access to the parent entity |
| 403 | `SCOPE_DENIED` | The key lacks the `crm` scope |
| 401 | `TOKEN_MISSING` | The key has no Bitrix24 connection |

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

## Known specifics

**The preset and owner cannot be changed.** `presetId`, `entityTypeId` and `entityId` in the update body are silently ignored: the response is `200` and the values stay the same. To change the preset or move the requisite to another contact or company, create a new requisite and delete the old one.

**A field with an unknown name is ignored.** A name that is not in [`GET /v1/requisites/fields`](/docs/entities/requisites/fields) is dropped without an error. A field from the schema is saved even if it is not in the requisite preset, for example `rqInn` on a requisite with the `Company` preset.

**An empty value clears the field.** To clear a string requisite field — `name`, `code`, `xmlId`, `originatorId` or an `rq*` field — pass an empty string `""` or `null`. For numeric fields (`sort`) and boolean fields (`active`, `addressOnly`, `rqVatPayer`, `rqStampPresent`), an empty string is rejected with `400 INVALID_PARAMS` as a type mismatch: send `null` or omit the field. For date fields (`rqCompanyRegDate`, `rqVatCertDate`, `rqBaseDocDate`, `rqRegCertDate`, `rqIdentDocDate`), an empty string clears the field. Cleared fields are returned as `null` in responses.

## See also

- [Get requisite](/docs/entities/requisites/get)
- [Requisite fields](/docs/entities/requisites/fields)
- [Create requisite](/docs/entities/requisites/create)
- [Delete requisite](/docs/entities/requisites/delete)
- [Batch](/docs/batch)
- [Limits and optimization](/docs/optimization)
