Add Custom Field user.userfield.add

Scope: user.userfield

Who can execute the method: administrator

The method user.userfield.add adds a custom field.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Values of the fields to add a new custom field

Parameter fields

Required parameters are marked with *

Name `type`	Description
FIELD_NAME* `string`	Name (code) of the field. Prefixed with `UF_USR_`
USER_TYPE_ID* `string`	Type of the custom field. Possible values: `string` — string `integer` — integer `double` — number `date` — date `datetime` — date with time `boolean` — Yes / No `file` — file `enumeration` — list `url` — link `address` — Google map address `money` — money `iblock_section` — Binding to the information block section `iblock_element` — Binding to the information block element `employee` — Binding to the user `crm` — Binding to the CRM entity `crm_status` — Binding to the CRM directory
XML_ID `string`	External code
SORT `integer`	Sorting order
MULTIPLE `boolean`	Is the field multiple. Possible values: `Y` — yes `N` — no
MANDATORY `boolean`	Is the custom field mandatory. Possible values: `Y` — yes `N` — no
SHOW_FILTER `boolean`	Show the field in the list filter. Possible values: `Y` — yes `N` — no
SHOW_IN_LIST `boolean`	Show the field in the list. Possible values: `Y` — yes `N` — no
EDIT_IN_LIST `boolean`	Edit the field in the list. Possible values: `Y` — yes `N` — no
IS_SEARCHABLE `boolean`	Is the field searchable. Possible values: `Y` — yes `N` — no
SETTINGS `object`	Object in the format `{"field_1": "value_1", ... "field_N": "value_N"}` for passing additional settings for custom fields. Settings are described below
EDIT_FORM_LABEL `string`	Label in the edit form. You can pass a string or an object with labels by languages in the format `{"de": "...", "en": "..."}`. When passing a string, the value will be set for all languages
LIST_COLUMN_LABEL `string`	Column header in the list. You can pass a string or an object with labels by languages in the format `{"de": "...", "en": "..."}`. When passing a string, the value will be set for all languages
LIST_FILTER_LABEL `string`	Filter header in the list. You can pass a string or an object with labels by languages in the format `{"de": "...", "en": "..."}`. When passing a string, the value will be set for all languages
ERROR_MESSAGE `string`	Error message for invalid input. You can pass a string or an object with texts by languages in the format `{"de": "...", "en": "..."}`. When passing a string, the value will be set for all languages
HELP_MESSAGE `string`	Help text for the field. You can pass a string or an object with texts by languages in the format `{"de": "...", "en": "..."}`. When passing a string, the value will be set for all languages
LABEL `string`	Default name of the custom field. The value will be set in the fields `LIST_FILTER_LABEL`, `LIST_COLUMN_LABEL`, `EDIT_FORM_LABEL`, `ERROR_MESSAGE`, `HELP_MESSAGE`, if no value is provided

Parameter SETTINGS

Each type of custom field has its own set of additional settings.

string

integer

double

boolean

date|datetime

enumeration

iblock_section|iblock_element

crm_status

crm

Name
type

Description

DEFAULT_VALUE
string

Default value.

Default is ''

ROWS
integer

Number of rows in the input field. Must be greater than 0.

Default is 1

Name `type`	Description
DEFAULT_VALUE `integer`	Default value

Name
type

Description

DEFAULT_VALUE
double

Default value

PRECISION
integer

Precision of the number. Must be greater than or equal to 0.

Default is 2

Name
type

Description

DEFAULT_VALUE
integer

Default value, where 1 — yes, 0 — no.

Possible values:

>= 1 -> 1
<= 0 -> 0

Default is 0

DISPLAY
string

Appearance. Possible values:

CHECKBOX — checkbox
RADIO — radio buttons
DROPDOWN — dropdown list

Default is CHECKBOX

Name
type

Description

DEFAULT_VALUE
object

Default value.

Object format:

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

where:

VALUE — default value of type datetime or date
TYPE — type of the default value:
- NONE — do not set a default value
- NOW — use the current time/date
- FIXED — use the time/date from VALUE

Default value:

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

Name
type

Description

DISPLAY
string

Appearance. Possible values:

LIST — list
UI — input list
CHECKBOX — checkboxes
DIALOG — entity selection dialog

Default is LIST

LIST_HEIGHT

Height of the list. Must be greater than 0.

Available only when DISPLAY = LIST or DISPLAY = UI.

Default is 1

Name `type`	Description
IBLOCK_TYPE_ID `string`	Identifier of the information block type. Default is `''`
IBLOCK_ID `string`	Identifier of the information block. Default is `0`
DEFAULT_VALUE `string`	Default value. Default is `''`
DISPLAY `string`	Appearance. Possible values: `DIALOG` — dialog `UI` — input list `LIST` — list `CHECKBOX` — checkboxes Default is `LIST`
LIST_HEIGHT `integer`	Height of the list. Must be greater than 0. Default is `1`
ACTIVE_FILTER `boolean`	Show elements with the active flag enabled. Possible values: `Y` — yes `N` — no Default is `N`

Name
type

Description

ENTITY_TYPE
string

Identifier of the directory type.

Use crm.status.entity.types to find possible values.

Default is ''

If none of the following options are provided, the binding to leads will be enabled by default (LEAD = Y).

Name `type`	Description
LEAD `boolean`	Is the binding to Leads enabled. Possible values: `Y` — yes `N` — no Default is `N`
CONTACT `boolean`	Is the binding to Contacts enabled. Possible values: `Y` — yes `N` — no Default is `N`
COMPANY `boolean`	Is the binding to Companies enabled. Possible values: `Y` — yes `N` — no Default is `N`
DEAL `boolean`	Is the binding to Deals enabled. Possible values: `Y` — yes `N` — no Default is `N`

If you need to create a custom field with an added custom type via the API, you must specify rest_<app_number>_<USER_TYPE_ID of the added type> in the USER_TYPE_ID field. For example, rest_436278_test_type.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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": "Binding to CRM deals",
                "EDIT_FORM_LABEL": {
                    "de": "Binding to CRM deals"
                }
            }
        }' \
        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": "Binding to CRM deals",
                "EDIT_FORM_LABEL": {
                    "de": "Binding to CRM deals"
                }
            },
            "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/user.userfield.add

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: 'Binding to CRM deals',
                        EDIT_FORM_LABEL: {
                            de: 'Binding to CRM deals'
                        },
                    }
                }
            );
        
            const result = response.getData().result;
            console.log('Created element with ID:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

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' => 'Binding to CRM deals',
                            'EDIT_FORM_LABEL' => [
                                'de' => 'Binding to CRM deals'
                            ],
                        ]
                    ]
                );
        
            $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: "Binding to CRM deals",
                    EDIT_FORM_LABEL: {
                        de: "Binding to CRM deals"
                    },
                },
            },
            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' => 'Binding to CRM deals',
                    'EDIT_FORM_LABEL' => [
                        'de' => 'Binding to CRM deals'
                    ],
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 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
            }
        }

Returned Data

Name `type`	Description
result `integer`	Identifier of the created custom field
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

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

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
ERROR_ARGUMENT	Argument 'USER_TYPE_ID' is null or empty	`USER_TYPE_ID` is not set
ERROR_ARGUMENT	Argument 'HANDLER' is null or empty	`HANDLER` is not set
ERROR_CORE	Field *** for the USER object already exists	Field *** for the `USER` object already exists
ERROR_CORE	Fail to create new user field	Error creating field
Empty string	The \u0027FIELD_NAME\u0027 field is not found.	Mandatory field `FIELD_NAME` is not set
Empty string	The \u0027USER_TYPE_ID\u0027 field is not found.	Mandatory field `USER_TYPE_ID` is not set

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of Methods

Delete Custom Field

Add Custom Field user.userfield.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Parameter SETTINGSParameter SETTINGS

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

Parameter fields

Parameter SETTINGS

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning