Добавить вариант в поле-список v 3.0 crm.<тип>.field.custom.enum.add

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

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

Scope: crm

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

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

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

Поле-список хранит набор вариантов, из которых пользователь выбирает значение, например приоритет «Высокий», «Средний», «Низкий». Создать само поле-список методом crm.<тип>.field.custom.add нельзя: он не принимает тип enumeration. Методы вариантов crm.<тип>.field.custom.enum.* работают с полями-списками, созданными в интерфейсе Битрикс24 или другими способами. Поля-списки есть в ответе метода crm.<тип>.field.custom.list: у них userTypeId равен enumeration.

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

Тип объекта

Метод

Поля

Сделка

crm.deal.field.custom.enum.add

Поля сделки

Лид

crm.lead.field.custom.enum.add

Поля лида

Контакт

crm.contact.field.custom.enum.add

Поля контакта

Компания

crm.company.field.custom.enum.add

Поля компании

Предложение

crm.quote.field.custom.enum.add

Поля предложения

Счет

crm.smartinvoice.field.custom.enum.add

Поля счета

Смарт-процесс

crm.smartprocess<entityTypeId>.field.custom.enum.add, например crm.smartprocess1038.field.custom.enum.add

Поля смарт-процесса

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

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

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

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

Название
тип

Описание

fields*
object

Объект с данными варианта в формате {"параметр": "значение"}. Обязательные поля — fieldId и value. Описание параметра

Параметр fields

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

Название
тип

Описание

fieldId*
integer | string

Идентификатор поля-списка или его имя, например 6008205 или "UF_CRM_19_PRIORITY". Идентификатор и имя поля возвращает метод crm.<тип>.field.custom.list

value*
string

Текст варианта, который видит пользователь, например Срочный. Пустую строку метод не принимает

isDefault
boolean

Выбран ли вариант по умолчанию у новых элементов.

Возможные значения:

  • true — вариант выбран по умолчанию
  • false — не выбран

По умолчанию: false

sort
integer

Порядок варианта в списке.

По умолчанию: 500

xmlId
string

Внешний код варианта, уникальный в пределах поля. Если код не передан, Битрикс24 создаст его сам, например crm_rest_enum_geu7u4uivzmoxv0ytjmransvcbi44rxq

Поле id метод не принимает: идентификатор варианта Битрикс24 назначает сам.

Примеры кода

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

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

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

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"fieldId":6008205,"value":"Срочный","sort":5,"xmlId":"URGENT"}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.field.custom.enum.add

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"fieldId":6008205,"value":"Срочный","sort":5,"xmlId":"URGENT"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.field.custom.enum.add

Методы 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 EnumAddResult = {
  item: {
    id: number
    fieldId: number
    value: string
    isDefault: boolean
    sort: number
    xmlId: string
  }
}

try {
  const response = await $b24.getHttpClient(ApiVersion.v3).call<EnumAddResult>(
    'crm.smartprocess1038.field.custom.enum.add',
    {
      fields: {
        fieldId: 6008205,
        value: 'Срочный',
        sort: 5,
        xmlId: 'URGENT',
      },
    },
    Text.getUuidRfc4122()
  )

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Value added:', 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 addEnumValue() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
        'crm.smartprocess1038.field.custom.enum.add',
        {
          fields: {
            fieldId: 6008205,
            value: 'Срочный',
            sort: 5,
            xmlId: 'URGENT',
          },
        },
        B24Js.Text.getUuidRfc4122()
      )

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

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

  document.addEventListener('DOMContentLoaded', addEnumValue)
</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.add"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})

try:
    response = bitrix_token.call_method(
        api_method=method,
        params={
            "fields": {
                "fieldId": 6008205,
                "value": "Срочный",
                "sort": 5,
                "xmlId": "URGENT",
            },
        },
        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.add',
            [
                'fields' => [
                    'fieldId' => 6008205,
                    'value' => 'Срочный',
                    'sort' => 5,
                    'xmlId' => 'URGENT',
                ],
            ]
        );

    $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.add',
    {
        fields: {
            fieldId: 6008205,
            value: 'Срочный',
            sort: 5,
            xmlId: 'URGENT',
        },
    },
    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.add',
    [
        'fields' => [
            'fieldId' => 6008205,
            'value' => 'Срочный',
            'sort' => 5,
            'xmlId' => 'URGENT',
        ],
    ]
);

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

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.smartprocess1038.field.custom.enum.add", b24.Params{
	"fields": b24.Params{
		"fieldId": 6008205,
		"value":   "Срочный",
		"sort":    5,
		"xmlId":   "URGENT",
	},
})
if err != nil {
	return fmt.Errorf("crm.smartprocess1038.field.custom.enum.add: %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": 5,
            "xmlId": "URGENT"
        }
    },
    "time": {
        "start": 1793714980,
        "finish": 1793714981.218989,
        "duration": 1.2189888954162598,
        "processing": 1,
        "date_start": "2026-11-03T17:09:40+03:00",
        "date_finish": "2026-11-03T17:09:41+03:00",
        "operating_reset_at": 1793715540,
        "operating": 0.5316870212554932
    }
}

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

Название
тип

Описание

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_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "Элемент списка со значением XML_ID=URGENT уже существует.",
                "field": "fields.xmlId"
            }
        ]
    }
}

Название
тип

Описание

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_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

fields

Обязательное поле fields не указано

Передайте объект fields

fields.value

В поле fields.value требуется тип данных non-empty string для такого запроса

Передайте непустой текст варианта

fields.xmlId

Элемент списка со значением XML_ID=#XML_ID# уже существует.

Передайте другой xmlId: внешний код уникален в пределах поля

isDefault

В поле isDefault требуется тип данных bool для такого запроса

Передайте true или false

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

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

fieldId

Не заполнено обязательное поле "fieldId"

Передайте fieldId в fields

value

Не заполнено обязательное поле "value"

Передайте value в fields

id

Поле "id" не доступно к заполнению

Уберите id из fields: идентификатор варианта Битрикс24 назначает сам

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

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

Поле

Описание ошибки

Как исправить

-

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

Проверьте идентификатор поля методом crm.<тип>.field.custom.list. Та же ошибка придет, если поле относится к другому типу объекта или не является списком

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

Код ошибки: 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.add. Для смарт-процесса проверьте 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

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Предыдущая
Удалить пользовательское поле
Следующая
Изменить вариант поля-списка