Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Добавить пользовательское поле user.userfield.add». Мы подготовили подробный разбор принципов работы и развернутые примеры интеграции.

Добавить пользовательское поле user.userfield.add

> Scope: user.userfield
>
> Кто может выполнять метод: администратор

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

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

Параметр fields

Параметр SETTINGS {#settings}

У каждого типа пользовательских полей существует свой набор дополнительных настроек.

• string

• integer

• double

• boolean

• date|datetime

    {
        VALUE: datetime|date,
        TYPE: 'NONE'|'NOW'|'FIXED',
    }

    {
        VALUE: '',
        TYPE: 'NONE',
    }

• enumeration

• iblock_section|iblock_element

• crm_status

• crm

Если не передать ни одну из следующих опций, то по умолчанию будет включена привязка к лидам (LEAD = Y).

Если необходимо через API создать пользовательское поле с добавленным пользовательским типом, в поле USER_TYPE_ID необходимо указывать rest_<номер приложения>_<USER_TYPE_ID добавленного типа>. Например rest_436278_test_type.

Примеры кода

• cURL (Webhook)

    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_webbhook_here**/user.userfield.add

• cURL (OAuth)

    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

• JS

    try
    {
        const response = await $b24.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'
                    },
                }
            }
        );

        const result = response.getData().result;
        console.log('Created element with ID:', result);
        processResult(result);
    }
    catch( error )
    {
        console.error('Error:', error);
    }

• PHP

    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.js

    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());
        }
    );

• PHP CRest

    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
    }
}

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

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

HTTP-статус: 400

{
   "error":"",
   "error_description":"The \u0027FIELD_NAME\u0027 field is not found."
}

Возможные коды ошибок

• [](./user-userfield-update)
• [](./user-userfield-list)
• [](./user-userfield-delete)