Для AI-агентов: markdown этой страницы — /docs-content/entities/crm-field-enum/update.md индекс документации — /llms.txt

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

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 значения. Источник: список значений
ПараметрentityTypeId (path) Типnumber Обяз.да для альтернативного пути ОписаниеДля альтернативного пути: ID смарт-процесса или 31 для счетов

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

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

Примеры

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

Terminal 
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-приложение

Terminal 
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 варианта из списка значений
Полеdata.fieldId Типnumber ОписаниеID пользовательского поля CRM или поля смарт-процесса
Поле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 Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНекорректный тип или форма параметра
HTTP400 КодUNKNOWN_FILTER_FIELD ОписаниеНеизвестный или повторяющийся параметр запроса
HTTP401 КодMISSING_API_KEY ОписаниеНе передан API-ключ
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет токенов Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа crm
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеНет права на операцию в Битрикс24
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч разрешает только чтение
HTTP404 КодENTITY_NOT_FOUND ОписаниеЗначение списка не найдено
HTTP422 КодMETHOD_NOT_YET_AVAILABLE ОписаниеВозможность выключена или недоступна на портале. Целевое обновление указано в error.release
HTTP422 КодBITRIX_ERROR ОписаниеОтказ Битрикс24. Причина в error.message
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 вернул некорректный ответ

Полный список общих ошибок API — Ошибки.

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