## Обновить тип плательщика

`PATCH /v1/person-types/:id`

Изменяет настройки существующего типа плательщика интернет-магазина для использования в заказах и их свойствах.

Поля передаются плоско в корне JSON, без обёртки `fields`.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `id` (path) | number | да | ID типа плательщика, целое неотрицательное число. Список: [`GET /v1/person-types`](./list.md) |

## Поля запроса (body)

| Поле | Тип | Обяз. | Описание |
|------|-----|:-----:|---------|
| `name` | string | да | Название. Чтобы сохранить прежнее, возьмите его из [`GET /v1/person-types/:id`](./get.md) |
| `code` | string \| null | нет | Уникальный код. Значение `null` оставляет прежний код |
| `sort` | number | нет | Порядок сортировки |
| `active` | boolean | нет | Активность типа |
| `xmlId` | string \| null | нет | Внешний идентификатор. Значение `null` оставляет прежний идентификатор |

Полный список полей — [`GET /v1/person-types/fields`](./fields.md).

## Примеры

### curl — личный ключ

```bash
curl -X PATCH "https://vibecode.bitrix24.tech/v1/person-types/21" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Updated documentation payer",
  "sort": 910,
  "active": true
}'
```

### curl — OAuth-приложение

```bash
curl -X PATCH "https://vibecode.bitrix24.tech/v1/person-types/21" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Updated documentation payer",
  "sort": 910,
  "active": true
}'
```

### JavaScript — личный ключ

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/person-types/21', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Updated documentation payer',
    sort: 910,
    active: true,
  }),
})

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

### JavaScript — OAuth-приложение

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/person-types/21', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Updated documentation payer',
    sort: 910,
    active: true,
  }),
})

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

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | `true` при успехе. HTTP-статус ответа — `200` |
| `data` | object | Обновлённый тип плательщика |
| `data.id` | number | RO. ID типа плательщика |
| `data.name` | string | Название |
| `data.code` | string \| null | Уникальный код |
| `data.sort` | number | Порядок сортировки |
| `data.active` | boolean | Активность типа |
| `data.xmlId` | string \| null | Внешний идентификатор |

## Пример ответа

```json
{
  "success": true,
  "data": {
    "active": true,
    "code": "DOCS_PERSON_397F55D8FB1D",
    "id": 21,
    "name": "Updated documentation payer",
    "sort": 910,
    "xmlId": "DOCS_PERSON_397F55D8FB1D"
  }
}
```

## Пример ответа при ошибке

422 — передано `active`, но отсутствует `name`:

```json
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Required fields: name",
    "b24Code": "0"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `EMPTY_UPDATE_BODY` | Тело запроса пустое |
| 400 | `NO_RECOGNIZED_UPDATE_FIELDS` | В теле нет ни одного изменяемого поля типа плательщика |
| 400 | `READONLY_FIELD` | Передано поле только для чтения: `id` или `lid` |
| 400 | `INVALID_PARAMS` | В скалярное поле передан объект или массив, например объект в `active` |
| 400 | `INVALID_PARAMS` | `id` в пути не является целым неотрицательным числом |
| 404 | `ENTITY_NOT_FOUND` | Типа плательщика с таким `id` нет. Текст — `person type is not exists` |
| 422 | `BITRIX_ERROR` | Не передано `name`. Текст — `Required fields: name`, `b24Code` — `0` |
| 422 | `BITRIX_ERROR` | Битрикс24 отклонил изменение по другой причине, в том числе из-за занятого `code`. Текст причины — в `message` |
| 403 | `BITRIX_ACCESS_DENIED` | У пользователя ключа нет прав на изменение типов плательщиков в Битрикс24 |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ работает в режиме только для чтения |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `sale` |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |

Полный список общих ошибок API — [Ошибки](/docs/errors).

## Смотрите также

- [Типы плательщиков](/docs/entities/person-types)
- [Получить тип плательщика](./get.md)
- [Создать тип плательщика](./create.md)
- [Поля типа плательщика](./fields.md)
- [Удалить тип плательщика](./delete.md)