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.userfieldWho can execute the method: administrator
The user.userfield.update method changes the settings and labels of a custom profile field. The FIELD_NAME code, the USER_TYPE_ID type, and the MULTIPLE flag cannot be changed after the field is created.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Custom field identifier. To obtain custom field identifiers, use the user.userfield.list method. |
|
fields |
Field settings to change (detailed description). Settings and labels that are not passed keep their current values. If |
Parameter fields
|
Name |
Description |
|
XML_ID |
External code |
|
SORT |
Sort order |
|
SHOW_FILTER |
Whether to show the field in the list filter. Possible values:
|
|
SETTINGS |
Additional field settings. The set depends on the field type (detailed description). Pass only the settings you need to change: the method merges them into the saved settings rather than replacing them entirely |
|
LIST |
Value options for an |
|
Caption in the edit form. You can pass a string or an object with language-specific captions in |
|
|
Column header in the list. You can pass a string or an object with language-specific captions in |
|
|
Filter header in the list. You can pass a string or an object with language-specific captions in |
|
|
Error message for invalid input. You can pass a string or an object with language-specific texts in |
|
|
Tooltip text for the field. You can pass a string or an object with language-specific texts in |
|
|
LABEL |
Default custom field name. The value will be set in fields |
The method ignores, without an error, parameters that cannot be changed: the FIELD_NAME code, the USER_TYPE_ID type, the MULTIPLE flag, as well as MANDATORY, SHOW_IN_LIST, EDIT_IN_LIST, and IS_SEARCHABLE.
Parameter SETTINGS
Each type of custom field has its own set of additional configurations.
|
Name |
Description |
|
DEFAULT_VALUE |
Default value. Default |
|
ROWS |
Number of lines in the input field. Must be greater than 0. Default |
|
Name |
Description |
|
DEFAULT_VALUE |
Default value |
|
Name |
Description |
|
DEFAULT_VALUE |
Default value |
|
PRECISION |
Number precision. Must be greater than or equal to 0. Default |
|
Name |
Description |
|
DEFAULT_VALUE |
Default value, where Possible values:
Default |
|
DISPLAY |
Appearance. Possible values:
Default |
For a date field, the method does not change SETTINGS: the default value can be set only on creation with the user.userfield.add method.
|
Name |
Description |
|
DEFAULT_VALUE |
Default value. Object format:
where:
Default value:
|
|
Name |
Description |
|
DISPLAY |
Appearance. Possible values:
Default |
|
LIST_HEIGHT |
List height. Must be greater than 0. Available only when Default |
|
Name |
Description |
|
IBLOCK_TYPE_ID |
Iblock type identifier. Default |
|
IBLOCK_ID |
Information block identifier. Default |
|
DEFAULT_VALUE |
Default value. Default |
|
DISPLAY |
Appearance. Possible values:
Default |
|
LIST_HEIGHT |
List height. Must be greater than 0. Default |
|
ACTIVE_FILTER |
Whether to show items with the activity flag enabled. Possible values:
Default is |
|
Name |
Description |
|
ENTITY_TYPE |
Directory type identifier. Use Default |
The method changes only the bindings that are passed; the rest keep their current values.
|
Name |
Description |
|
LEAD |
Whether binding to Leads is enabled. Possible values:
|
|
CONTACT |
Whether binding to Contacts is enabled. Possible values:
|
|
COMPANY |
Whether binding to Companies is enabled. Possible values:
|
|
DEAL |
Whether binding to Deals is enabled. Possible values:
|
For file, url, address, money, and employee fields, the method does not change SETTINGS: the passed settings are ignored, and the saved field settings stay the same. For an employee field, the SHOW_FILTER = Y value is saved as I, an exact match filter.
Parameter LIST
Value options for an enumeration field. Pass only the options you need to change, add, or delete: the other options are retained.
|
Name |
Description |
|
ID |
ID of an existing option. It is returned by the user.userfield.list method in the |
|
VALUE |
Option text |
|
SORT |
Option order in the list |
|
DEF |
Default option:
|
|
XML_ID |
External code of the option. If you do not pass |
|
DEL |
Delete the option with the specified
|
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": 1793288729,
"finish": 1793288730.001057,
"duration": 1.0010569095611572,
"processing": 1,
"date_start": "2026-10-29T18:45:29+01:00",
"date_finish": "2026-10-29T18:45:30+01:00",
"operating_reset_at": 1793289300,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
|
|
time |
Request execution time information |
Error Handling
HTTP status: 400
{
"error": "",
"error_description": "Access denied."
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
Empty string |
Access denied. |
The user does not have administrator permissions, the field with the passed |
|
|
Empty string |
ID is not defined or invalid. |
The |
|
|
|
The request requires higher privileges than provided by the webhook token |
The webhook or application does not have the |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |