Добавить пользовательское поле user.userfield.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
user.userfieldКто может выполнять метод: администратор
Метод user.userfield.add добавляет пользовательское поле.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Значения полей для добавления нового пользовательского поля |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
FIELD_NAME* |
Название (код) поля. Дополняется префиксом |
|
USER_TYPE_ID* |
Тип пользовательского поля. Возможные значения:
|
|
XML_ID |
Внешний код |
|
SORT |
Порядок сортировки |
|
MULTIPLE |
Является ли поле множественным. Возможные значения:
|
|
MANDATORY |
Является ли пользовательское поле обязательным. Возможные значения:
|
|
SHOW_FILTER |
Показывать ли поле в фильтре списка. Возможные значения:
|
|
SHOW_IN_LIST |
Показывать ли поле в списке. Возможные значения:
|
|
EDIT_IN_LIST |
Редактировать ли поле в списке. Возможные значения:
|
|
IS_SEARCHABLE |
Участвует ли поле в поиске. Возможные значения:
|
|
SETTINGS |
Объект в формате |
|
EDIT_FORM_LABEL |
Подпись в форме редактирования. Можно передать строку или объект с подписями по языкам в формате |
|
LIST_COLUMN_LABEL |
Заголовок столбца в списке. Можно передать строку или объект с подписями по языкам в формате |
|
LIST_FILTER_LABEL |
Заголовок фильтра в списке. Можно передать строку или объект с подписями по языкам в формате |
|
ERROR_MESSAGE |
Сообщение об ошибке при невалидном вводе. Можно передать строку или объект с текстами по языкам в формате |
|
HELP_MESSAGE |
Текст подсказки к полю. Можно передать строку или объект с текстами по языкам в формате |
|
LABEL |
Название пользовательского поля по умолчанию. Значение будет выставлено в поля |
Параметр 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 |
Включена ли привязка к Сделкам. Возможные значения:
По умолчанию |
Пример
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
fields = {
"FIELD_NAME": "UF_USR_SKILLS_PROFILE",
"USER_TYPE_ID": "string",
"XML_ID": "UF_USR_SKILLS_PROFILE",
"SORT": 150,
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "Y",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"IS_SEARCHABLE": "Y",
"SETTINGS": {
"DEFAULT_VALUE": "Python integration engineer",
"ROWS": 3,
},
"EDIT_FORM_LABEL": {
"en": "Skills profile",
},
"LIST_COLUMN_LABEL": {
"en": "Skills profile",
},
"LIST_FILTER_LABEL": {
"en": "Skills profile",
},
"ERROR_MESSAGE": {
"en": "Skills profile is invalid",
},
"HELP_MESSAGE": {
"en": "Store a short integration skills summary.",
},
"LABEL": "Skills profile",
}
try:
bitrix_response = client.user.userfield.add(
fields=fields,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print("Bitrix SDK error", error.message, sep="\n")
except Exception as error:
print("Unexpected error", error, sep="\n")
Если необходимо через API создать пользовательское поле с добавленным пользовательским типом, в поле USER_TYPE_ID необходимо указывать rest_<номер приложения>_<USER_TYPE_ID добавленного типа>. Например rest_436278_test_type.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields": {
"FIELD_NAME": "UF_USER_DEALS",
"USER_TYPE_ID": "crm",
"XML_ID": "UF_CRM_DEALS",
"SORT": 100,
"MULTIPLE": "Y",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"SETTINGS": {
"DEAL": "Y"
},
"LABEL": "Привязка к сделкам CRM",
"EDIT_FORM_LABEL": {
"ru": "Привязка к сделкам CRM"
}
}
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.userfield.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields": {
"FIELD_NAME": "UF_USER_DEALS",
"USER_TYPE_ID": "crm",
"XML_ID": "UF_CRM_DEALS",
"SORT": 100,
"MULTIPLE": "Y",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "Y",
"EDIT_IN_LIST": "Y",
"SETTINGS": {
"DEAL": "Y"
},
"LABEL": "Привязка к сделкам CRM",
"EDIT_FORM_LABEL": {
"ru": "Привязка к сделкам CRM"
}
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/user.userfield.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type AddUserFieldResult = number
try {
const response = await $b24.actions.v2.call.make<AddUserFieldResult>({
method: 'user.userfield.add',
params: {
fields: {
FIELD_NAME: 'UF_USER_DEALS',
USER_TYPE_ID: 'crm',
XML_ID: 'UF_CRM_DEALS',
SORT: 100,
MULTIPLE: 'Y',
MANDATORY: 'N',
SHOW_FILTER: 'N',
SHOW_IN_LIST: 'Y',
EDIT_IN_LIST: 'Y',
SETTINGS: {
DEAL: 'Y',
},
LABEL: 'CRM deals binding',
EDIT_FORM_LABEL: {
ru: 'CRM deals binding',
},
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Created user field with ID:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addUserField() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'user.userfield.add',
params: {
fields: {
FIELD_NAME: 'UF_USER_DEALS',
USER_TYPE_ID: 'crm',
XML_ID: 'UF_CRM_DEALS',
SORT: 100,
MULTIPLE: 'Y',
MANDATORY: 'N',
SHOW_FILTER: 'N',
SHOW_IN_LIST: 'Y',
EDIT_IN_LIST: 'Y',
SETTINGS: {
DEAL: 'Y',
},
LABEL: 'CRM deals binding',
EDIT_FORM_LABEL: {
ru: 'CRM deals binding',
},
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Created user field with ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addUserField)
</script>
try {
$response = $b24Service
->core
->call(
'user.userfield.add',
[
'fields' => [
'FIELD_NAME' => 'UF_USER_DEALS',
'USER_TYPE_ID' => 'crm',
'XML_ID' => 'UF_CRM_DEALS',
'SORT' => 100,
'MULTIPLE' => 'Y',
'MANDATORY' => 'N',
'SHOW_FILTER' => 'N',
'SHOW_IN_LIST' => 'Y',
'EDIT_IN_LIST' => 'Y',
'SETTINGS' => [
'DEAL' => 'Y',
],
'LABEL' => 'Привязка к сделкам CRM',
'EDIT_FORM_LABEL' => [
'ru' => 'Привязка к сделкам CRM'
],
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding user field: ' . $e->getMessage();
}
BX24.callMethod(
'user.userfield.add',
{
fields: {
FIELD_NAME: "UF_USER_DEALS",
USER_TYPE_ID: "crm",
XML_ID: "UF_CRM_DEALS",
SORT: 100,
MULTIPLE: "Y",
MANDATORY: "N",
SHOW_FILTER: "N",
SHOW_IN_LIST: "Y",
EDIT_IN_LIST: "Y",
SETTINGS: {
DEAL: "Y",
},
LABEL: "Привязка к сделкам CRM",
EDIT_FORM_LABEL: {
ru: "Привязка к сделкам CRM"
},
},
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'user.userfield.add',
[
'fields' => [
'FIELD_NAME' => 'UF_USER_DEALS',
'USER_TYPE_ID' => 'crm',
'XML_ID' => 'UF_CRM_DEALS',
'SORT' => 100,
'MULTIPLE' => 'Y',
'MANDATORY' => 'N',
'SHOW_FILTER' => 'N',
'SHOW_IN_LIST' => 'Y',
'EDIT_IN_LIST' => 'Y',
'SETTINGS' => [
'DEAL' => 'Y',
],
'LABEL' => 'Привязка к сделкам CRM',
'EDIT_FORM_LABEL' => [
'ru' => 'Привязка к сделкам CRM'
],
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result":177,
"time":{
"start":1747301035.550121,
"finish":1747301037.514112,
"duration":1.9639909267425537,
"processing":0.5865437984466553,
"date_start":"2025-05-15T11:23:55+02:00",
"date_finish":"2025-05-15T11:23:57+02:00",
"operating":0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Идентификатор созданного пользовательского поля |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":"",
"error_description":"The \u0027FIELD_NAME\u0027 field is not found."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
ERROR_ARGUMENT |
Argument 'USER_TYPE_ID' is null or empty |
Не задан |
|
ERROR_ARGUMENT |
Argument 'HANDLER' is null or empty |
Не задан |
|
ERROR_CORE |
Поле *** для объекта USER уже существует |
Поле *** для объекта |
|
ERROR_CORE |
Fail to create new user field |
Ошибка при создании поля |
|
Пустая строка |
The \u0027FIELD_NAME\u0027 field is not found. |
Не задано обязательное поле |
|
Пустая строка |
The \u0027USER_TYPE_ID\u0027 field is not found. |
Не задано обязательное поле |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Обновить пользовательское поле user.userfield.update
- Получить список пользовательских полей user.userfield.list
- Удалить пользовательское поле user.userfield.delete