метод REST scope: user.userfield

user.userfield.add

Добавить пользовательское поле

Кто может выполнять: администратор

Описание

Метод user.userfield.add добавляет пользовательское поле.

Параметры

fields object обязательный

Значения полей для добавления нового пользовательского поля

Параметр fields

FIELD_NAME string обязательный

Название (код) поля. Битрикс24 приводит его к верхнему регистру и дополняет префиксом UF_USR_:

  • DEALS и UF_DEALS превратятся в UF_USR_DEALS
  • UF_USR_DEALS останется без изменений

Итоговый код поля возвращает метод user.userfield.list

USER_TYPE_ID string обязательный

Тип пользовательского поля. Возможные значения:
- string — строка
- integer — целое число
- double — число
- date — дата
- datetime — дата со временем
- boolean — Да / Нет
- file — файл
- enumeration — список
- url — ссылка
- address — адрес Google карты
- money — деньги
- iblock_section — Привязка к разделу инфоблока
- iblock_element — Привязка к элементу инфоблока
- employee — Привязка к пользователю
- crm — Привязка к элементу CRM
- crm_status — Привязка к справочнику CRM

XML_ID string необязательный

Внешний код

SORT integer необязательный

Порядок сортировки

MULTIPLE boolean необязательный

Является ли поле множественным. Возможные значения:
- Y — да
- N — нет

MANDATORY boolean необязательный

Является ли пользовательское поле обязательным. Возможные значения:
- Y — да
- N — нет

SHOW_FILTER boolean необязательный

Показывать ли поле в фильтре списка. Возможные значения:
- Y — да
- N — нет

SHOW_IN_LIST boolean необязательный

Показывать ли поле в списке. Возможные значения:
- Y — да
- N — нет

EDIT_IN_LIST boolean необязательный

Редактировать ли поле в списке. Возможные значения:
- Y — да
- N — нет

IS_SEARCHABLE boolean необязательный

Участвует ли поле в поиске. Возможные значения:
- Y — да
- N — нет

SETTINGS object необязательный

Объект в формате {"field_1": "value_1", ... "field_N": "value_N"} для передачи дополнительных настроек пользовательских полей. Настройки описаны ниже

EDIT_FORM_LABEL string необязательный

Подпись в форме редактирования. Можно передать строку или объект с подписями по языкам в формате {"ru": "...", "en": "..."}. При передаче строки значение будет выставлено для всех языков

LIST_COLUMN_LABEL string необязательный

Заголовок столбца в списке. Можно передать строку или объект с подписями по языкам в формате {"ru": "...", "en": "..."}. При передаче строки значение будет выставлено для всех языков

LIST_FILTER_LABEL string необязательный

Заголовок фильтра в списке. Можно передать строку или объект с подписями по языкам в формате {"ru": "...", "en": "..."}. При передаче строки значение будет выставлено для всех языков

ERROR_MESSAGE string необязательный

Сообщение об ошибке при невалидном вводе. Можно передать строку или объект с текстами по языкам в формате {"ru": "...", "en": "..."}. При передаче строки значение будет выставлено для всех языков

HELP_MESSAGE string необязательный

Текст подсказки к полю. Можно передать строку или объект с текстами по языкам в формате {"ru": "...", "en": "..."}. При передаче строки значение будет выставлено для всех языков

LABEL string необязательный

Название пользовательского поля по умолчанию.

Значение будет выставлено в поля LIST_FILTER_LABEL, LIST_COLUMN_LABEL, EDIT_FORM_LABEL, ERROR_MESSAGE, HELP_MESSAGE, если в них не передано значение

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields": {
        "FIELD_NAME": "UF_USR_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

Ответ

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 integer

Идентификатор созданного пользовательского поля

time time

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
   "error":"",
   "error_description":"The \u0027FIELD_NAME\u0027 field is not found."
}
Код Описание Значение
ERROR_ARGUMENT Argument 'USER_TYPE_ID' is null or empty Не задан USER_TYPE_ID
ERROR_ARGUMENT Argument 'HANDLER' is null or empty Не задан HANDLER
ERROR_CORE Поле \* для объекта USER уже существует Поле \* для объекта USER уже существует
ERROR_CORE Fail to create new user field Ошибка при создании поля
Пустая строка The \u0027FIELD_NAME\u0027 field is not found. Не задано обязательное поле FIELD_NAME
Пустая строка The \u0027USER_TYPE_ID\u0027 field is not found. Не задано обязательное поле USER_TYPE_ID

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.