Создать пользовательское поле для лидов crm.lead.userfield.add
Scope:
crmКто может выполнять метод: администратор CRM
Метод crm.lead.userfield.add создает новое пользовательское поле для лидов.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Объект формата:
Список доступных полей описан ниже. Некорректное поле в |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
USER_TYPE_ID* |
Тип данных пользовательского поля. Возможные значения:
|
|
FIELD_NAME* |
Код поля. Уникальное. Системное ограничение на код поля составляет 20 знаков. К названию пользовательского поля всегда добавляется префикс Допустимые символы: |
|
LABEL |
Название пользовательского поля по умолчанию. Переданное значение будет выставлено в следующие поля: |
|
XML_ID |
Внешний код |
|
Подпись фильтра в списке. При передаче строки она будет проставлена для всех идентификаторов языка. При передаче значения типа По умолчанию значение, переданное в |
|
|
Заголовок в списке. При передаче строки она будет проставлена для всех идентификаторов языка. При передаче значения типа По умолчанию значение, переданное в |
|
|
Подпись в форме редактирования. При передаче строки она будет проставлена для всех идентификаторов языка. При передаче значения типа По умолчанию значение, переданное в |
|
|
Сообщение об ошибке |
|
|
Помощь |
|
|
MULTIPLE |
Является ли поле множественным. Возможные значения:
Поля типа По умолчанию |
|
MANDATORY |
Является ли поле обязательным. Возможные значения:
По умолчанию |
|
SHOW_FILTER |
Показывать ли поле в фильтре. Возможные значения:
По умолчанию |
|
SETTINGS |
Дополнительные параметры поля. Для каждого типа поля |
|
LIST |
Список возможных значений для пользовательского поля типа По умолчанию |
|
SORT |
Индекс сортировки. Обязательно больше нуля. По умолчанию |
|
SHOW_IN_LIST |
Показывать ли пользовательское поле в списке. Данный параметр ни на что не влияет в рамках Возможные значения:
По умолчанию |
|
EDIT_IN_LIST |
Разрешать ли редактирование пользователем. Возможные значения:
По умолчанию |
|
IS_SEARCHABLE |
Участвуют ли значения поля в поиске. Данный параметр ни на что не влияет в рамках Возможные значения:
По умолчанию |
Параметр SETTINGS
У каждого типа пользовательских полей существует свой набор дополнительных настроек. Данный метод поддерживает лишь те, что описаны ниже.
|
Название |
Описание |
|
DEFAULT_VALUE |
Значение по умолчанию. По умолчанию |
|
ROWS |
Количество строк в поле ввода. Обязательно больше 0. По умолчанию |
|
Название |
Описание |
|
DEFAULT_VALUE |
Значение по умолчанию |
|
Название |
Описание |
|
DEFAULT_VALUE |
Значение по умолчанию |
|
PRECISION |
Точность числа. Обязательно больше или равно 0. По умолчанию |
|
Название |
Описание |
|
DEFAULT_VALUE |
Значение по умолчанию, где Возможные значения:
По умолчанию |
|
DISPLAY |
Внешний вид. Возможные значения:
По умолчанию |
|
Название |
Описание |
|
DEFAULT_VALUE |
Значение по умолчанию.
где:
Значение по умолчанию:
|
|
Название |
Описание |
|
DISPLAY |
Внешний вид. Возможные значения:
По умолчанию |
|
LIST_HEIGHT |
Высота списка. Обязательно больше 0. Доступен только при По умолчанию |
|
Название |
Описание |
|
IBLOCK_TYPE_ID |
Идентификатор типа инфоблока. По умолчанию |
|
IBLOCK_ID |
Идентификатор инфоблока. По умолчанию |
|
DEFAULT_VALUE |
Значение по умолчанию. По умолчанию |
|
DISPLAY |
Внешний вид. Возможные значения:
По умолчанию |
|
LIST_HEIGHT |
Высота списка. Обязательно больше 0. По умолчанию |
|
ACTIVE_FILTER |
Показывать ли элементы с включенным флагом активности. Возможные значения:
По умолчанию |
|
Название |
Описание |
|
ENTITY_TYPE |
Идентификатор типа справочника. Используйте По умолчанию |
Если не передать ни одну из следующих опций, то по умолчанию будет включена привязка к лидам LEAD = Y.
|
Название |
Описание |
|
LEAD |
Включена ли привязка к Лидам. Возможные значения:
По умолчанию |
|
CONTACT |
Включена ли привязка к Контактам. Возможные значения:
По умолчанию |
|
COMPANY |
Включена ли привязка к Компаниям. Возможные значения:
По умолчанию |
|
DEAL |
Включена ли привязка к Сделкам. Возможные значения:
По умолчанию |
Параметр LIST
|
Название |
Описание |
|
VALUE |
Значение элемента списка. Элементы списка с пустым или отсутствующим |
|
SORT |
Индекс сортировки. Обязательно больше или равно 0. По умолчанию |
|
DEF |
Является ли элемент списка значением по умолчанию. Возможные значения:
Для множественного поля допустимо несколько По умолчанию |
|
XML_ID |
Внешний код значения. Обязательно уникальный в рамках элементов списка пользовательского поля |
Примеры кода
Как использовать примеры в документации
Пример создания пользовательского поля типа Строка
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"LABEL":"Поле Привет, мир!","USER_TYPE_ID":"string","FIELD_NAME":"HELLO_WORLD","MULTIPLE":"Y","MANDATORY":"Y","SHOW_FILTER":"Y","SETTINGS":{"DEFAULT_VALUE":"Привет, мир! Значение по умолчанию","ROWS":3},"SORT":1000,"EDIT_IN_LIST":"Y","LIST_FILTER_LABEL":"Привет, мир! Фильтр","LIST_COLUMN_LABEL":{"en":"Hello, World! Column","ru":"Привет, мир! Колонка","de":"Hallo, Welt! Spalte"},"EDIT_FORM_LABEL":{"en":"Hello, World! Edit","ru":"Привет, мир! Редактировать","de":"Hallo, Welt! Bearbeiten"},"ERROR_MESSAGE":{"en":"Hello, World! Error","ru":"Привет, мир! Ошибка","de":"Hallo, Welt! Fehler"},"HELP_MESSAGE":{"en":"Hello, World! Help","ru":"Привет, мир! Помощь","de":"Hallo, Welt! Hilfe"}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.userfield.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"LABEL":"Поле Привет, мир!","USER_TYPE_ID":"string","FIELD_NAME":"HELLO_WORLD","MULTIPLE":"Y","MANDATORY":"Y","SHOW_FILTER":"Y","SETTINGS":{"DEFAULT_VALUE":"Привет, мир! Значение по умолчанию","ROWS":3},"SORT":1000,"EDIT_IN_LIST":"Y","LIST_FILTER_LABEL":"Привет, мир! Фильтр","LIST_COLUMN_LABEL":{"en":"Hello, World! Column","ru":"Привет, мир! Колонка","de":"Hallo, Welt! Spalte"},"EDIT_FORM_LABEL":{"en":"Hello, World! Edit","ru":"Привет, мир! Редактировать","de":"Hallo, Welt! Bearbeiten"},"ERROR_MESSAGE":{"en":"Hello, World! Error","ru":"Привет, мир! Ошибка","de":"Hallo, Welt! Fehler"},"HELP_MESSAGE":{"en":"Hello, World! Help","ru":"Привет, мир! Помощь","de":"Hallo, Welt! Hilfe"}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.lead.userfield.add
try
{
const response = await $b24.callMethod(
'crm.lead.userfield.add',
{
fields: {
LABEL: 'Поле Привет, мир!',
USER_TYPE_ID: 'string',
FIELD_NAME: 'HELLO_WORLD',
MULTIPLE: 'Y',
MANDATORY: 'Y',
SHOW_FILTER: 'Y',
SETTINGS: {
DEFAULT_VALUE: 'Привет, мир! Значение по умолчанию',
ROWS: 3,
},
SORT: 1000,
EDIT_IN_LIST: 'Y',
LIST_FILTER_LABEL: 'Привет, мир! Фильтр',
LIST_COLUMN_LABEL: {
en: 'Hello, World! Column',
ru: 'Привет, мир! Колонка',
de: 'Hallo, Welt! Spalte',
},
EDIT_FORM_LABEL: {
en: 'Hello, World! Edit',
ru: 'Привет, мир! Редактировать',
de: 'Hallo, Welt! Bearbeiten',
},
ERROR_MESSAGE: {
en: 'Hello, World! Error',
ru: 'Привет, мир! Ошибка',
de: 'Hallo, Welt! Fehler',
},
HELP_MESSAGE: {
en: 'Hello, World! Help',
ru: 'Привет, мир! Помощь',
de: 'Hallo, Welt! Hilfe',
},
},
}
);
console.info(response.getData().result);
}
catch (error)
{
console.error(error);
}
try {
$userfieldItemFields = [
'FIELD_NAME' => 'HELLO_WORLD',
'USER_TYPE_ID' => 'string',
'SORT' => 1000,
'MULTIPLE' => 'Y',
'MANDATORY' => 'Y',
'SHOW_FILTER' => 'Y',
'EDIT_IN_LIST' => 'Y',
'LIST_FILTER_LABEL' => 'Привет, мир! Фильтр',
'LIST_COLUMN_LABEL' => [
'en' => 'Hello, World! Column',
'ru' => 'Привет, мир! Колонка',
'de' => 'Hallo, Welt! Spalte',
],
'EDIT_FORM_LABEL' => [
'en' => 'Hello, World! Edit',
'ru' => 'Привет, мир! Редактировать',
'de' => 'Hallo, Welt! Bearbeiten',
],
'ERROR_MESSAGE' => [
'en' => 'Hello, World! Error',
'ru' => 'Привет, мир! Ошибка',
'de' => 'Hallo, Welt! Fehler',
],
'HELP_MESSAGE' => [
'en' => 'Hello, World! Help',
'ru' => 'Привет, мир! Помощь',
'de' => 'Hallo, Welt! Hilfe',
],
'SETTINGS' => [
'DEFAULT_VALUE' => 'Привет, мир! Значение по умолчанию',
'ROWS' => 3,
],
];
$result = $serviceBuilder
->getCRMScope()
->leadUserfield()
->add($userfieldItemFields);
print($result->getId());
} catch (Throwable $e) {
print('Error: ' . $e->getMessage());
}
BX24.callMethod(
'crm.lead.userfield.add',
{
fields: {
LABEL: 'Поле Привет, мир!',
USER_TYPE_ID: 'string',
FIELD_NAME: 'HELLO_WORLD',
MULTIPLE: 'Y',
MANDATORY: 'Y',
SHOW_FILTER: 'Y',
SETTINGS: {
DEFAULT_VALUE: 'Привет, мир! Значение по умолчанию',
ROWS: 3,
},
SORT: 1000,
EDIT_IN_LIST: 'Y',
},
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.lead.userfield.add',
[
'fields' => [
'LABEL' => 'Поле Привет, мир!',
'USER_TYPE_ID' => 'string',
'FIELD_NAME' => 'HELLO_WORLD',
'MULTIPLE' => 'Y',
'MANDATORY' => 'Y',
'SHOW_FILTER' => 'Y',
'SETTINGS' => [
'DEFAULT_VALUE' => 'Привет, мир! Значение по умолчанию',
'ROWS' => 3,
],
'SORT' => 1000,
'EDIT_IN_LIST' => 'Y',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Пример создания пользовательского поля типа Список
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"LABEL":"Пользовательское поле (список)","USER_TYPE_ID":"enumeration","FIELD_NAME":"ENUMERATION_EXAMPLE","MULTIPLE":"N","MANDATORY":"N","SHOW_FILTER":"Y","LIST":[{"VALUE":"Элемент списка #1","DEF":"Y","XML_ID":"XML_ID_1","SORT":100},{"VALUE":"Элемент списка #2","XML_ID":"XML_ID_2","SORT":200},{"VALUE":"Элемент списка #3","XML_ID":"XML_ID_3","SORT":300},{"VALUE":"Элемент списка #4","XML_ID":"XML_ID_4","SORT":400}],"SETTINGS":{"DISPLAY":"UI","LIST_HEIGHT":2},"SORT":2000}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.userfield.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"LABEL":"Пользовательское поле (список)","USER_TYPE_ID":"enumeration","FIELD_NAME":"ENUMERATION_EXAMPLE","MULTIPLE":"N","MANDATORY":"N","SHOW_FILTER":"Y","LIST":[{"VALUE":"Элемент списка #1","DEF":"Y","XML_ID":"XML_ID_1","SORT":100},{"VALUE":"Элемент списка #2","XML_ID":"XML_ID_2","SORT":200},{"VALUE":"Элемент списка #3","XML_ID":"XML_ID_3","SORT":300},{"VALUE":"Элемент списка #4","XML_ID":"XML_ID_4","SORT":400}],"SETTINGS":{"DISPLAY":"UI","LIST_HEIGHT":2},"SORT":2000},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.lead.userfield.add
try
{
const response = await $b24.callMethod(
'crm.lead.userfield.add',
{
fields: {
LABEL: 'Пользовательское поле (список)',
USER_TYPE_ID: 'enumeration',
FIELD_NAME: 'ENUMERATION_EXAMPLE',
MULTIPLE: 'N',
MANDATORY: 'N',
SHOW_FILTER: 'Y',
LIST: [
{ VALUE: 'Элемент списка #1', DEF: 'Y', XML_ID: 'XML_ID_1', SORT: 100 },
{ VALUE: 'Элемент списка #2', XML_ID: 'XML_ID_2', SORT: 200 },
{ VALUE: 'Элемент списка #3', XML_ID: 'XML_ID_3', SORT: 300 },
{ VALUE: 'Элемент списка #4', XML_ID: 'XML_ID_4', SORT: 400 },
],
SETTINGS: {
DISPLAY: 'UI',
LIST_HEIGHT: 2,
},
SORT: 2000,
},
}
);
console.info(response.getData().result);
}
catch (error)
{
console.error(error);
}
try {
$userfieldItemFields = [
'LABEL' => 'Пользовательское поле (список)',
'USER_TYPE_ID' => 'enumeration',
'FIELD_NAME' => 'ENUMERATION_EXAMPLE',
'MULTIPLE' => 'N',
'MANDATORY' => 'N',
'SHOW_FILTER' => 'Y',
'LIST' => [
['VALUE' => 'Элемент списка #1', 'DEF' => 'Y', 'XML_ID' => 'XML_ID_1', 'SORT' => 100],
['VALUE' => 'Элемент списка #2', 'XML_ID' => 'XML_ID_2', 'SORT' => 200],
['VALUE' => 'Элемент списка #3', 'XML_ID' => 'XML_ID_3', 'SORT' => 300],
['VALUE' => 'Элемент списка #4', 'XML_ID' => 'XML_ID_4', 'SORT' => 400],
],
'SETTINGS' => ['DISPLAY' => 'UI', 'LIST_HEIGHT' => 2],
'SORT' => 2000,
];
$result = $serviceBuilder
->getCRMScope()
->leadUserfield()
->add($userfieldItemFields);
print($result->getId());
} catch (Throwable $e) {
print('Error: ' . $e->getMessage());
}
BX24.callMethod(
'crm.lead.userfield.add',
{
fields: {
LABEL: 'Пользовательское поле (список)',
USER_TYPE_ID: 'enumeration',
FIELD_NAME: 'ENUMERATION_EXAMPLE',
MULTIPLE: 'N',
MANDATORY: 'N',
SHOW_FILTER: 'Y',
LIST: [
{ VALUE: 'Элемент списка #1', DEF: 'Y', XML_ID: 'XML_ID_1', SORT: 100 },
{ VALUE: 'Элемент списка #2', XML_ID: 'XML_ID_2', SORT: 200 },
{ VALUE: 'Элемент списка #3', XML_ID: 'XML_ID_3', SORT: 300 },
{ VALUE: 'Элемент списка #4', XML_ID: 'XML_ID_4', SORT: 400 },
],
SETTINGS: { DISPLAY: 'UI', LIST_HEIGHT: 2 },
SORT: 2000,
},
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.lead.userfield.add',
[
'fields' => [
'LABEL' => 'Пользовательское поле (список)',
'USER_TYPE_ID' => 'enumeration',
'FIELD_NAME' => 'ENUMERATION_EXAMPLE',
'MULTIPLE' => 'N',
'MANDATORY' => 'N',
'SHOW_FILTER' => 'Y',
'LIST' => [
['VALUE' => 'Элемент списка #1', 'DEF' => 'Y', 'XML_ID' => 'XML_ID_1', 'SORT' => 100],
['VALUE' => 'Элемент списка #2', 'XML_ID' => 'XML_ID_2', 'SORT' => 200],
['VALUE' => 'Элемент списка #3', 'XML_ID' => 'XML_ID_3', 'SORT' => 300],
['VALUE' => 'Элемент списка #4', 'XML_ID' => 'XML_ID_4', 'SORT' => 400],
],
'SETTINGS' => [
'DISPLAY' => 'UI',
'LIST_HEIGHT' => 2,
],
'SORT' => 2000,
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": 6997,
"time": {
"start": 1753789240.8146,
"finish": 1753789241.058695,
"duration": 0.2440950870513916,
"processing": 0.19217395782470703,
"date_start": "2025-07-29T14:40:40+03:00",
"date_finish": "2025-07-29T14:40:41+03:00",
"operating_reset_at": 1753789840,
"operating": 0.19216084480285645
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа, содержит идентификатор созданного пользовательского поля |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "The 'USER_TYPE_ID' field is not found."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
The 'FIELD_NAME' field is not found |
Либо передан пустой |
|
|
Имя поля слишком длинное (больше 50-ти символов). |
Переданный |
|
|
Имя поля содержит недопустимые символы. Допустимыми являются: A-Z, 0-9 и _. |
Переданный |
|
|
The 'USER_TYPE_ID' field is not found |
Либо передан пустой |
|
|
Указан неверный пользовательский тип |
Переданный |
|
|
Элемент списка со значением XML_ID='XML_ID' уже существует |
Переданные в элементы списка |
Продолжите изучение
- Изменить существующее пользовательское поле лидов crm.lead.userfield.update
- Получить пользовательское поле лидов по id crm.lead.userfield.get
- Получить список пользовательских полей лидов crm.lead.userfield.list
- Удалить пользовательское поле лидов crm.lead.userfield.delete