user.userfield.add
Добавить пользовательское поле
Описание
Метод user.userfield.add добавляет пользовательское поле.
Параметры
fields
object
обязательный
Значения полей для добавления нового пользовательского поля
Параметр fields
FIELD_NAME
string
обязательный
Название (код) поля. Битрикс24 приводит его к верхнему регистру и дополняет префиксом UF_USR_:
DEALSиUF_DEALSпревратятся вUF_USR_DEALSUF_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
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"
}
},
"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_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 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_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 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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.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",
},
},
).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(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'user.userfield.add',
[
'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'
],
]
]
);
$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_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"
},
},
},
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_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'
],
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "user.userfield.add", b24.Params{
"fields": b24.Params{
"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": b24.Params{
"DEAL": "Y",
},
"LABEL": "Привязка к сделкам CRM",
"EDIT_FORM_LABEL": b24.Params{
"ru": "Привязка к сделкам CRM",
},
},
})
if err != nil {
return fmt.Errorf("user.userfield.add: %w", err)
}
var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)
Ответ
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 |

