Изменить вариант поля-списка v 3.0 crm.<тип>.field.custom.enum.update

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: пользователь с правом «Разрешить изменять настройки» в CRM

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод crm.<тип>.field.custom.enum.update изменяет вариант пользовательского поля-списка и возвращает описание варианта. Тип объекта задает сегмент <тип> в имени метода.

Имя метода для типа объекта

Тип объекта	Метод	Поля
Сделка	`crm.deal.field.custom.enum.update`	Поля сделки
Лид	`crm.lead.field.custom.enum.update`	Поля лида
Контакт	`crm.contact.field.custom.enum.update`	Поля контакта
Компания	`crm.company.field.custom.enum.update`	Поля компании
Предложение	`crm.quote.field.custom.enum.update`	Поля предложения
Счет	`crm.smartinvoice.field.custom.enum.update`	Поля счета
Смарт-процесс	`crm.smartprocess<entityTypeId>.field.custom.enum.update`, например `crm.smartprocess1038.field.custom.enum.update`	Поля смарт-процесса

Для смарт-процесса в имя метода подставляется идентификатор его типа entityTypeId. Идентификаторы типов смарт-процессов возвращает метод crm.type.list в поле entityTypeId. Методы вариантов полей-списков есть у смарт-процесса при любых настройках типа. У моей компании этих методов нет: на crm.mycompany.field.custom.enum.update Битрикс24 ответит ошибкой «Метод не найден».

Имя метода пишется в нижнем регистре: crm.smartinvoice.field.custom.enum.update, а не crm.smartInvoice.field.custom.enum.update. На имя в другом регистре метод отвечает ошибкой «Метод не найден».

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
id* `integer`	Идентификатор варианта. Идентификаторы вариантов возвращает метод crm.<тип>.field.custom.enum.list
fields* `object`	Объект с новыми данными варианта в формате `{"параметр": "значение"}`. Описание параметра

Параметр fields

Передайте только те параметры, которые нужно изменить.

Название `тип`	Описание
value `string`	Текст варианта, который видит пользователь, например `Срочный`. Пустую строку метод не принимает
isDefault `boolean`	Выбран ли вариант по умолчанию у новых элементов. Возможные значения: `true` — вариант выбран по умолчанию `false` — не выбран
sort `integer`	Порядок варианта в списке
xmlId `string`	Внешний код варианта, уникальный в пределах поля

Параметр fieldId метод не меняет и ошибку не возвращает: вариант остается в своем поле. Пустой объект fields метод тоже принимает и возвращает вариант без изменений.

Метод не снимает признак isDefault с других вариантов. Если у поля уже есть вариант по умолчанию, а вы передадите "isDefault": true для другого, признак будет у обоих. Чтобы оставить один, передайте "isDefault": false для прежнего варианта.

Примеры кода

Как использовать примеры в документации

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/crm.smartprocess1038.field.custom.enum.update

Примеры меняют текст и порядок варианта в поле «Приоритет» смарт-процесса с идентификатором типа 1038. Для другого типа объекта замените имя метода по таблице выше.

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":4135,"fields":{"value":"Очень срочный","sort":1}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.field.custom.enum.update

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":4135,"fields":{"value":"Очень срочный","sort":1},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.field.custom.enum.update

Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make: такой вызов вернет ошибку SDK JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(ApiVersion.v3).call.

import { ApiVersion, Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type EnumUpdateResult = {
  item: {
    id: number
    fieldId: number
    value: string
    isDefault: boolean
    sort: number
    xmlId: string
  }
}

try {
  const response = await $b24.getHttpClient(ApiVersion.v3).call<EnumUpdateResult>(
    'crm.smartprocess1038.field.custom.enum.update',
    {
      id: 4135,
      fields: {
        value: 'Очень срочный',
        sort: 1,
      },
    },
    Text.getUuidRfc4122()
  )

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Value updated:', result.item.id, result.item.value)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(B24Js.ApiVersion.v3).call.

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function updateEnumValue() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
        'crm.smartprocess1038.field.custom.enum.update',
        {
          id: 4135,
          fields: {
            value: 'Очень срочный',
            sort: 1,
          },
        },
        B24Js.Text.getUuidRfc4122()
      )

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Value updated:', result.item.id, result.item.value)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updateEnumValue)
</script>

У методов CRM нет готовых оберток в b24pysdk, и SDK отправляет в REST 3.0 только методы из списка Config().api_v3_methods. Добавьте метод в этот список и вызовите его через bitrix_token.call_method с prefer_version=3.

from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError

method = "crm.smartprocess1038.field.custom.enum.update"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})

try:
    response = bitrix_token.call_method(
        api_method=method,
        params={
            "id": 4135,
            "fields": {
                "value": "Очень срочный",
                "sort": 1,
            },
        },
        prefer_version=3,
    )
    result = response["result"]
    print(result["item"]["id"], result["item"]["value"])
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"code: {error.code}",
        f"message: {error.error.message}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'crm.smartprocess1038.field.custom.enum.update',
            [
                'id' => 4135,
                'fields' => [
                    'value' => 'Очень срочный',
                    'sort' => 1,
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'crm.smartprocess1038.field.custom.enum.update',
    {
        id: 4135,
        fields: {
            value: 'Очень срочный',
            sort: 1,
        },
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'crm.smartprocess1038.field.custom.enum.update',
    [
        'id' => 4135,
        'fields' => [
            'value' => 'Очень срочный',
            'sort' => 1,
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.smartprocess1038.field.custom.enum.update", b24.Params{
	"id": 4135,
	"fields": b24.Params{
		"value": "Очень срочный",
		"sort":  1,
	},
})
if err != nil {
	return fmt.Errorf("crm.smartprocess1038.field.custom.enum.update: %w", err)
}

var out struct {
	Item struct {
		ID    int    `json:"id"`
		Value string `json:"value"`
	} `json:"item"`
}
if err := json.Unmarshal(res.Result, &out); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(out.Item.ID, out.Item.Value)

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 4135,
            "fieldId": 6008205,
            "value": "Очень срочный",
            "isDefault": false,
            "sort": 1,
            "xmlId": "URGENT"
        }
    },
    "time": {
        "start": 1793714989,
        "finish": 1793714989.621933,
        "duration": 0.6219329833984375,
        "processing": 0,
        "date_start": "2026-11-03T17:09:49+03:00",
        "date_finish": "2026-11-03T17:09:49+03:00",
        "operating_reset_at": 1793715540,
        "operating": 0
    }
}

Возвращаемые данные

Название `тип`	Описание
result `object`	Объект с данными ответа
result.item `object`	Описание варианта. Поля варианта
time `time`	Информация о времени выполнения запроса

Поля варианта

Название `тип`	Описание
id `integer`	Идентификатор варианта
fieldId `integer`	Идентификатор поля-списка
value `string`	Текст варианта
isDefault `boolean`	Выбран ли вариант по умолчанию
sort `integer`	Порядок варианта в списке
xmlId `string`	Внешний код варианта

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
        "message": "Запись с ID = `99999999` не найдена"
    }
}

Название `тип`	Описание
error.code `string`	Строковый код ошибки. Используйте для идентификации типа исключения
error.message `string`	Текстовое описание ошибки
error.validation `array`	Массив c деталями ошибки. Присутствует только в ошибках валидации данных `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Название поля, в котором возникла ошибка валидации
error.validation[].message `string`	Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Вариант не найден

Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Запись с ID = `#ID#` не найдена	Проверьте идентификатор варианта методом crm.<тип>.field.custom.enum.list. Если в `id` передана строка не из цифр, в тексте ошибки будет `0`

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Не заполнено значение хотя бы одного обязательного поля: id, filter	Передайте `id` варианта
`fields`	Обязательное поле `fields` не указано	Передайте объект `fields`
`fields.value`	В поле `fields.value` требуется тип данных `non-empty string` для такого запроса	Передайте непустой текст варианта
`fields.xmlId`	Элемент списка со значением XML_ID=`#XML_ID#` уже существует.	Передайте другой `xmlId`: внешний код уникален в пределах поля

Ошибки валидации объекта

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`id`	Поле "id" не доступно к заполнению	Уберите `id` из `fields`: идентификатор варианта передается в параметре `id` на одном уровне с `fields`

Поле не найдено

Код ошибки: BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION, HTTP-статус 404

Поле	Описание ошибки	Как исправить
`-`	Поле `#ID#` не найдено	Вариант принадлежит полю другого типа объекта. Проверьте, что тип объекта в имени метода совпадает с типом поля

Ошибка неизвестного поля

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Неизвестное поле `#FIELD#` для сущности `EnumDto`	Проверьте имя параметра по таблице параметра fields

Ошибка доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION, HTTP-статус 403

Поле	Описание ошибки	Как исправить
`-`	Доступ запрещен	Вызовите метод от имени пользователя с правом «Разрешить изменять настройки» в CRM

Метод не найден

Код ошибки: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP-статус 404

Поле	Описание ошибки	Как исправить
`-`	Метод `#METHOD#` не найден	Проверьте имя метода: оно пишется в нижнем регистре, например `crm.smartinvoice.field.custom.enum.update`. Для смарт-процесса проверьте `entityTypeId` методом crm.type.list. У моей компании этих методов нет

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Была ли статья полезна?

Добавить вариант в поле-список

Получить вариант поля-списка

Изменить вариант поля-списка v 3.0 crm.<тип>.field.custom.enum.update

Имя метода для типа объектаИмя метода для типа объекта

Параметры методаПараметры метода

Параметр fieldsПараметр fields

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Поля вариантаПоля варианта

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Вариант не найденВариант не найден

Ошибки валидации запросаОшибки валидации запроса

Ошибки валидации объектаОшибки валидации объекта

Поле не найденоПоле не найдено

Ошибка неизвестного поляОшибка неизвестного поля

Ошибка доступаОшибка доступа

Метод не найденМетод не найден

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение

Была ли статья полезна?

Имя метода для типа объекта

Параметры метода

Параметр fields

Примеры кода

Обработка ответа

Возвращаемые данные

Поля варианта

Обработка ошибок

Возможные коды ошибок

Вариант не найден

Ошибки валидации запроса

Ошибки валидации объекта

Поле не найдено

Ошибка неизвестного поля

Ошибка доступа

Метод не найден

Статусы и коды системных ошибок

Продолжите изучение