Update custom field user.userfield.update

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: user.userfield

Who can execute the method: administrator

The user.userfield.update method updates a custom field.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Custom field identifier.

To obtain custom field identifiers, use the user.userfield.list method.

fields
object

Field values for updating the custom field

Parameter fields

Name
type

Description

XML_ID
string

External code

SORT
integer

Sort order

MANDATORY
boolean

Whether the custom field is mandatory. Possible values:

  • Y — yes
  • N — no

SHOW_FILTER
boolean

Whether to show the field in the list filter. Possible values:

  • Y — yes
  • N — no

SHOW_IN_LIST
boolean

Whether to show the field in the list. Possible values:

  • Y — yes
  • N — no

EDIT_IN_LIST
boolean

Whether to allow editing the field in the list. Possible values:

  • Y — yes
  • N — no

IS_SEARCHABLE
boolean

Whether the field is included in the search. Possible values:

  • Y — yes
  • N — no

SETTINGS
object

An object in {"field_1": "value_1", ... "field_N": "value_N"} format to pass additional custom field settings. Settings are described below

EDIT_FORM_LABEL
string

Caption in the edit form. You can pass a string or an object with language-specific captions in {"de": "...", "en": "..."} format. If a string is passed, the value will be applied to all languages

LIST_COLUMN_LABEL
string

Column header in the list. You can pass a string or an object with language-specific captions in {"de": "...", "en": "..."} format. If a string is passed, the value will be applied to all languages

LIST_FILTER_LABEL
string

Filter header in the list. You can pass a string or an object with language-specific captions in {"de": "...", "en": "..."} format. If a string is passed, the value will be applied to all languages

ERROR_MESSAGE
string

Error message for invalid input. You can pass a string or an object with language-specific texts in {"de": "...", "en": "..."} format. If a string is passed, the value will be applied to all languages

HELP_MESSAGE
string

Tooltip text for the field. You can pass a string or an object with language-specific texts in {"de": "...", "en": "..."} format. If a string is passed, the value will be applied to all languages

LABEL
string

Default custom field name.

The value will be set in fields LIST_FILTER_LABEL, LIST_COLUMN_LABEL, EDIT_FORM_LABEL, ERROR_MESSAGE, HELP_MESSAGE if no value is provided for them

Parameter SETTINGS

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

Name
type

Description

DEFAULT_VALUE
string

Default value.

Default ''

ROWS
integer

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

Default 1

Name
type

Description

DEFAULT_VALUE
integer

Default value

Name
type

Description

DEFAULT_VALUE
double

Default value

PRECISION
integer

Number precision. Must be greater than or equal to 0.

Default 2

Name
type

Description

DEFAULT_VALUE
integer

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

Possible values:

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

Default 0

DISPLAY
string

Appearance. Possible values:

  • CHECKBOX — checkbox
  • RADIO — radio buttons
  • DROPDOWN — dropdown list

Default 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 default value:
    • NONE — do not set a default value
    • NOW — use current time/date
    • FIXED — use time/date from VALUE

Default value:

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

Name
type

Description

DISPLAY
string

Appearance. Possible values:

  • LIST — list
  • UI — editable list
  • CHECKBOX — checkboxes
  • DIALOG — entity selection dialog

Default LIST

LIST_HEIGHT

List height. Must be greater than 0.

Available only when DISPLAY = LIST or DISPLAY = UI.

Default 1

Name
type

Description

IBLOCK_TYPE_ID
string

Iblock type identifier.

Default ''

IBLOCK_ID
string

Information block identifier.

Default 0

DEFAULT_VALUE
string

Default value.

Default ''

DISPLAY
string

Appearance. Possible values:

  • DIALOG — dialog
  • UI — editable list
  • LIST — list
  • CHECKBOX — checkboxes

Default LIST

LIST_HEIGHT
integer

List height. Must be greater than 0.

Default 1

ACTIVE_FILTER
boolean

Whether to show items with the activity flag enabled. Possible values:

  • Y — yes
  • N — no

Default is N

Name
type

Description

ENTITY_TYPE
string

Directory type identifier.

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

Default ''

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

Name
type

Description

LEAD
boolean

Whether binding to Leads is enabled. Possible values:

  • Y — yes
  • N — no

Default is N

CONTACT
boolean

Whether binding to Contacts is enabled. Possible values:

  • Y — yes
  • N — no

Default is N

COMPANY
boolean

Whether binding to Companies is enabled. Possible values:

  • Y — yes
  • N — no

Default is N

DEAL
boolean

Whether binding to Deals is enabled. Possible values:

  • Y — yes
  • N — no

Default is N

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        bitrix_id = 176
        fields = {
            "XML_ID": "UF_USR_SKILLS_PROFILE_V2",
            "SORT": 200,
            "MANDATORY": "N",
            "SHOW_FILTER": "Y",
            "SHOW_IN_LIST": "Y",
            "EDIT_IN_LIST": "Y",
            "IS_SEARCHABLE": "Y",
            "SETTINGS": {
                "DEFAULT_VALUE": "Senior Python integration engineer",
                "ROWS": 4,
            },
            "EDIT_FORM_LABEL": {
                "en": "Skills profile",
            },
            "LIST_COLUMN_LABEL": {
                "en": "Skills profile",
            },
            "LIST_FILTER_LABEL": {
                "en": "Skills profile",
            },
            "ERROR_MESSAGE": {
                "en": "Skills profile is invalid",
            },
            "HELP_MESSAGE": {
                "en": "Update the short integration skills summary.",
            },
            "LABEL": "Skills profile",
        }
        
        try:
            bitrix_response = client.user.userfield.update(
                bitrix_id=bitrix_id,
                fields=fields,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print("Bitrix SDK error", error.message, sep="\n")
        except Exception as error:
            print("Unexpected error", error, sep="\n")
        

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "id": 42,
            "fields": {
                "SORT": 150,
                "LIST_FILTER_LABEL": "New Title",
                "LIST_COLUMN_LABEL": "New List Title"
            }
        }' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.userfield.update
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "id": 42,
            "fields": {
                "SORT": 150,
                "LIST_FILTER_LABEL": "New Title",
                "LIST_COLUMN_LABEL": "New List Title"
            },
            "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/user.userfield.update
        
// 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 UpdateUserFieldResult = boolean
        
        try {
          const response = await $b24.actions.v2.call.make<UpdateUserFieldResult>({
            method: 'user.userfield.update',
            params: {
              id: 42,
              fields: {
                SORT: 150,
                LIST_FILTER_LABEL: 'New Title',
                LIST_COLUMN_LABEL: 'New List Title',
              },
            },
            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('User field updated:', 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 updateUserField() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'user.userfield.update',
                params: {
                  id: 42,
                  fields: {
                    SORT: 150,
                    LIST_FILTER_LABEL: 'New Title',
                    LIST_COLUMN_LABEL: 'New List Title',
                  },
                },
                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('User field updated:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateUserField)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.user.userfield.update(
                bitrix_id=42,
                fields={
                    "SORT": 150,
                    "LIST_FILTER_LABEL": "New Title",
                    "LIST_COLUMN_LABEL": "New List Title",
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'user.userfield.update',
                    [
                        'id' => 42,
                        'fields' => [
                            'SORT' => 150,
                            'LIST_FILTER_LABEL' => 'New Title',
                            'LIST_COLUMN_LABEL' => 'New List Title',
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating user field: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'user.userfield.update', 
            {
                id: 42,
                fields: {
                    SORT: 150,
                    LIST_FILTER_LABEL: 'New Title',
                    LIST_COLUMN_LABEL: 'New List Title',
                },
            },
            function(result) {
                if(result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'user.userfield.update',
            [
                'id' => 42,
                'fields' => [
                    'SORT' => 150,
                    'LIST_FILTER_LABEL' => 'New Title',
                    'LIST_COLUMN_LABEL' => 'New List Title',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "user.userfield.update", b24.Params{
        	"id": 42,
        	"fields": b24.Params{
        		"SORT":              150,
        		"LIST_FILTER_LABEL": "New Title",
        		"LIST_COLUMN_LABEL": "New List Title",
        	},
        })
        if err != nil {
        	return fmt.Errorf("user.userfield.update: %w", err)
        }
        
        var ok bool
        if err := json.Unmarshal(res.Result, &ok); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("done:", ok)
        

Response Handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start":1747311864.008399,
                "finish":1747311865.063292,
                "duration":1.0548930168151855,
                "processing":0.17107510566711426,
                "date_start":"2025-05-15T14:24:24+02:00",
                "date_finish":"2025-05-15T14:24:25+02:00",
                "operating":0
            }
        }
        

Returned Data

Name
type

Description

result
boolean

Contains true in case of a successful custom field update

time
time

Request execution time information

Error Handling

HTTP status: 400

{
            "error":"",
            "error_description":"Access denied."
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

Value

Empty string

Access denied.

A field with this id does not exist or access is denied

Empty string

ID is not defined or invalid

Not specified or an invalid id was entered

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it 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