Update User Field userfieldconfig.update

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: userfieldconfig, module scope from moduleId (for example, crm)

Who can execute the method: a user with permission to modify object settings in the moduleId module (for crm — permission "Allow to modify settings")

The userfieldconfig.update method updates the settings of an existing user field.

Method Parameters

Required parameters are marked with *

Name `type`	Description
moduleId* `string`	Identifier of the module where the field is located
id* `integer`	Identifier of the user field settings
field `object`	Object with new field settings (detailed description)

Parameter field

Name `type`	Description
xmlId `string`	External identifier of the field
sort `integer`	Sort index
mandatory `boolean`	Mandatory field flag (`Y`/`N`)
showFilter `boolean`	Show field in filter flag (`Y`/`N`)
isSearchable `boolean`	Field participation in search flag (`Y`/`N`)
editFormLabel `lang_map`	Labels in the edit form by languages
helpMessage `lang_map`	Help text by languages
settings `object`	Additional field settings. The set of keys depends on the field type (detailed description)
enum `uf_enum_element[]`	List of value options for the `enumeration` field type. To apply changes to `enum`, `field.userTypeId` must be set to `enumeration`
userTypeId `string`	Field type. Used when updating `enum`, in this case, set it to `enumeration`

Parameter settings

Each field type has its own set of keys in settings.

string

integer

double

boolean

date|datetime

money

url

address

file

enumeration

iblock_section|iblock_element

crm_status

crm

employee

rest_*

Name `type`
DEFAULT_VALUE `string`
ROWS `integer`
SIZE `integer`
REGEXP `string`
MIN_LENGTH `integer`
MAX_LENGTH `integer`

Name `type`
DEFAULT_VALUE `integer`
SIZE `integer`
MIN_VALUE `integer`
MAX_VALUE `integer`

Name `type`
DEFAULT_VALUE `double`
PRECISION `integer`
SIZE `integer`
MIN_VALUE `double`
MAX_VALUE `double`

Name `type`
DEFAULT_VALUE `integer`
DISPLAY `string`
LABEL `string`
LABEL_CHECKBOX `string`

Name `type`
DEFAULT_VALUE `object`
USE_SECOND `boolean`
USE_TIMEZONE `boolean`

Name `type`
DEFAULT_VALUE `string`

Name `type`
POPUP `boolean`
SIZE `integer`
MIN_LENGTH `integer`
MAX_LENGTH `integer`
DEFAULT_VALUE `string`
ROWS `integer`

Name `type`
SHOW_MAP `boolean`

Name `type`
SIZE `integer`
LIST_WIDTH `integer`
LIST_HEIGHT `integer`
MAX_SHOW_SIZE `integer`
MAX_ALLOWED_SIZE `integer`
EXTENSIONS `string[]`
TARGET_BLANK `boolean`

Name `type`
DISPLAY `string`
LIST_HEIGHT `integer`
CAPTION_NO_VALUE `string`
SHOW_NO_VALUE `boolean`

Name `type`
DISPLAY `string`
LIST_HEIGHT `integer`
IBLOCK_ID `integer`
DEFAULT_VALUE `string`
ACTIVE_FILTER `boolean`

Name `type`

Name `type`
LEAD `boolean`
CONTACT `boolean`
COMPANY `boolean`
DEAL `boolean`
QUOTE `boolean`
ORDER `boolean`
SMART_INVOICE `boolean`
DYNAMIC_* `boolean`

Separate settings in settings for the employee type are not used.

Settings are defined by the user-defined field type handler.

Type uf_enum_element

Name `type`	Description
id `integer`	Identifier of the existing option. Used for updating or deleting
value `string`	Value of the option
def `boolean`	Default value flag (`Y`/`N`)
sort `integer`	Sort index
xmlId `string`	External identifier of the option
del `boolean`	Flag for deleting the existing option (`Y`/`N`)

Some field parameters cannot be changed after creation. If they are passed in field, the change will not be applied.

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 '{"moduleId":"crm","id":7095,"field":{"mandatory":"Y","editFormLabel":{"en":"List of characteristics (updated)"}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/userfieldconfig.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"moduleId":"crm","id":7095,"field":{"mandatory":"Y","editFormLabel":{"en":"List of characteristics (updated)"}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/userfieldconfig.update

try
        {
            const response = await $b24.callMethod(
                'userfieldconfig.update',
                {
                    moduleId: 'crm',
                    id: 7095,
                    field: {
                        mandatory: 'Y',
                        editFormLabel: {
                            en: 'List of characteristics (updated)',
                        },
                    },
                }
            );
            
            const result = response.getData().result;
            console.info(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'userfieldconfig.update',
                    [
                        'moduleId' => 'crm',
                        'id' => 7095,
                        'field' => [
                            'mandatory' => 'Y',
                            'editFormLabel' => [
                                'en' => 'List of characteristics (updated)',
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Result: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'userfieldconfig.update',
            {
                moduleId: 'crm',
                id: 7095,
                field: {
                    mandatory: 'Y',
                    editFormLabel: {
                        en: 'List of characteristics (updated)',
                    },
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'userfieldconfig.update',
            [
                'moduleId' => 'crm',
                'id' => 7095,
                'field' => [
                    'mandatory' => 'Y',
                    'editFormLabel' => [
                        'en' => 'List of characteristics (updated)',
                    ],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "field": {
                    "id": "7095",
                    "entityId": "CRM_7",
                    "fieldName": "UF_CRM_7_NEW_REST_LIST_2026",
                    "userTypeId": "enumeration",
                    "xmlId": null,
                    "sort": "100",
                    "multiple": "Y",
                    "mandatory": "Y",
                    "showFilter": "N",
                    "showInList": "Y",
                    "editInList": "Y",
                    "isSearchable": "N",
                    "settings": {
                        "DISPLAY": "LIST",
                        "LIST_HEIGHT": 1,
                        "CAPTION_NO_VALUE": "",
                        "SHOW_NO_VALUE": "Y"
                    },
                    "languageId": {
                        "en": "en"
                    },
                    "editFormLabel": {
                        "en": "List of characteristics (updated)"
                    },
                    "listColumnLabel": {
                        "en": null
                    },
                    "listFilterLabel": {
                        "en": null
                    },
                    "errorMessage": {
                        "en": null
                    },
                    "helpMessage": {
                        "en": null
                    },
                    "enum": [
                        {
                            "id": "3671",
                            "userFieldId": "7095",
                            "value": "Characteristic 1",
                            "def": "N",
                            "sort": "100",
                            "xmlId": "38a8c98a5de02f8ccdca2244e5065ecd"
                        },
                        {
                            "id": "3673",
                            "userFieldId": "7095",
                            "value": "Characteristic 2",
                            "def": "Y",
                            "sort": "200",
                            "xmlId": "9520e17b39f3525b820b809914b52207"
                        }
                    ]
                }
            },
            "time": {
                "start": 1774356026,
                "finish": 1774356026.949068,
                "duration": 0.9490680694580078,
                "processing": 0,
                "date_start": "2026-03-24T15:40:26+01:00",
                "date_finish": "2026-03-24T15:40:26+01:00",
                "operating_reset_at": 1774356626,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response (detailed description)
time `time`	Information about the request execution time

Object result

Name `type`	Description
field `object`	Settings of the updated user field (detailed description)

Object field

Name `type`	Description
id `integer`	Identifier of the field settings
entityId `string`	Identifier of the object
fieldName `string`	Field code
userTypeId `string`	Identifier of the field type
xmlId `string`	External identifier of the field
sort `integer`	Sort index
multiple `boolean`	Multiple value flag (`Y`/`N`)
mandatory `boolean`	Mandatory field flag (`Y`/`N`)
showFilter `boolean`	Show field in filter flag
showInList `boolean`	Show field in list flag
editInList `boolean`	Edit in list flag
isSearchable `boolean`	Participation in search flag
settings `object`	Additional field settings. See Parameter settings. The set of keys depends on `userTypeId`
languageId `object`	Languages for which field labels are set
editFormLabel `lang_map`	Labels in the edit form
listColumnLabel `lang_map`	Column labels in the list
listFilterLabel `lang_map`	Filter labels
errorMessage `lang_map`	Error message text
helpMessage `lang_map`	Help text for the field
enum `object[]`	Value options. This field is returned only for `userTypeId = enumeration`

Error Handling

HTTP Status: 400

{
            "error": "",
            "error_description": "You cannot change the settings of the user field"
        }

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
`-`	You cannot change the settings of the user field	Insufficient permissions to modify the field. This same error is returned if the field with the provided `id` has already been deleted or is unavailable in the context of `moduleId`
`-`	The current method required more scopes. (crm)	The application does not have the required scope for the module from `moduleId`
`-`	No settings for UserFieldAccess	Access to user fields is not configured for the provided `moduleId`
`-`	Error while attempting to change user field settings	General error in changing the field

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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

List Custom Field Settings

Overview of Methods

Update User Field userfieldconfig.update

Method ParametersMethod Parameters

Parameter fieldParameter field

Parameter settingsParameter settings

Type uf_enum_elementType uf_enum_element

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Object resultObject result

Object fieldObject field

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning