## Изменить значение списочного поля

`PATCH /v1/userfields/:entity/enum-values/:id`

Изменяет один вариант списочного пользовательского поля CRM. Поля передаются в корне JSON без обёртки `fields`.

> **Доступность.** Возможность включается администратором и требует обновления CRM после версии 26.2200.0. Номер выпущенной версии ещё не определён. Если возможность недоступна, API возвращает `422 METHOD_NOT_YET_AVAILABLE` с полем `error.release`.

Альтернативный путь для смарт-процессов и счетов: `PATCH /v1/items/:entityTypeId/userfields/enum-values/:id`.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
| `entity` (path) | string | да | `deals`, `leads`, `contacts`, `companies`, `quotes`, `invoices` |
| `id` (path) | number | да | ID значения. Источник: [список значений](/docs/entities/crm-field-enum/list) |
| `entityTypeId` (path) | number | да для альтернативного пути | Для альтернативного пути: ID [смарт-процесса](/docs/entities/smart-processes/list) или `31` для счетов |

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

| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
| `value` | string | нет | Название варианта |
| `isDefault` | boolean | нет | Выбирать ли вариант по умолчанию |
| `sort` | integer | нет | Порядок сортировки |
| `xmlId` | string \| null | нет | Внешний идентификатор. `null` сохраняет текущее значение |

## Примеры

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

```bash
curl -X PATCH "https://vibecode.bitrix24.tech/v1/userfields/deals/enum-values/4119" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"value": "VIBE-PROBE changed"}'
```

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

```bash
curl -X PATCH "https://vibecode.bitrix24.tech/v1/userfields/deals/enum-values/4119" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"value": "VIBE-PROBE changed"}'
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/userfields/deals/enum-values/4119', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"value": "VIBE-PROBE changed"}),
})

const result = await res.json()
console.log(result)
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/userfields/deals/enum-values/4119', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"value": "VIBE-PROBE changed"}),
})

const result = await res.json()
console.log(result)
```

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

| Поле | Тип | Описание |
|---|---|---|
| `success` | boolean | `true` |
| `data` | object | Изменённый вариант |
| `data.id` | number | ID варианта из [списка значений](/docs/entities/crm-field-enum/list) |
| `data.fieldId` | number | ID [пользовательского поля CRM](/docs/userfields/crm/list) или [поля смарт-процесса](/docs/userfields/smart-processes/list) |
| `data.value` | string | Название варианта |
| `data.isDefault` | boolean | Выбран ли по умолчанию |
| `data.sort` | integer | Порядок сортировки |
| `data.xmlId` | string \| null | Внешний идентификатор |

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

```json
{
  "success": true,
  "data": {
    "id": 4119,
    "fieldId": 6008145,
    "value": "VIBE-PROBE changed",
    "isDefault": false,
    "sort": 500,
    "xmlId": "VIBE-PROBE-X"
  }
}
```

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

400 — попытка передать поле `id` в теле запроса:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Use enum fields fieldId (add only), value, isDefault, sort and xmlId with their documented types"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|---|---|---|
| 400 | `INVALID_PARAMS` | Некорректный тип или форма параметра |
| 400 | `UNKNOWN_FILTER_FIELD` | Неизвестный или повторяющийся параметр запроса |
| 401 | `MISSING_API_KEY` | Не передан API-ключ |
| 401 | `TOKEN_MISSING` | У ключа нет токенов Битрикс24 |
| 403 | `SCOPE_DENIED` | У ключа нет скоупа `crm` |
| 403 | `BITRIX_ACCESS_DENIED` | Нет права на операцию в Битрикс24 |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | Ключ разрешает только чтение |
| 404 | `ENTITY_NOT_FOUND` | Значение списка не найдено |
| 422 | `METHOD_NOT_YET_AVAILABLE` | Возможность выключена или недоступна на портале. Целевое обновление указано в `error.release` |
| 422 | `BITRIX_ERROR` | Отказ Битрикс24. Причина в `error.message` |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 вернул некорректный ответ |

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

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

- [Список значений списочного поля](/docs/entities/crm-field-enum/list)
- [Создать значение](/docs/entities/crm-field-enum/create)