Update custom field user.userfield.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:
user.userfieldWho can execute the method: administrator
The user.userfield.update method updates a custom field.
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 values for updating the custom field |
Parameter fields
|
Name |
Description |
|
XML_ID |
External code |
|
SORT |
Sort order |
|
MANDATORY |
Whether the custom field is mandatory. Possible values:
|
|
SHOW_FILTER |
Whether to show the field in the list filter. Possible values:
|
|
SHOW_IN_LIST |
Whether to show the field in the list. Possible values:
|
|
EDIT_IN_LIST |
Whether to allow editing the field in the list. Possible values:
|
|
IS_SEARCHABLE |
Whether the field is included in the search. Possible values:
|
|
SETTINGS |
An object in |
|
EDIT_FORM_LABEL |
Caption in the edit form. You can pass a string or an object with language-specific captions in |
|
LIST_COLUMN_LABEL |
Column header in the list. You can pass a string or an object with language-specific captions in |
|
LIST_FILTER_LABEL |
Filter header in the list. You can pass a string or an object with language-specific captions in |
|
ERROR_MESSAGE |
Error message for invalid input. You can pass a string or an object with language-specific texts in |
|
HELP_MESSAGE |
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 |
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 |
|
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 |
If none of the following options are passed, linking to leads (LEAD = Y) will be enabled by default.
|
Name |
Description |
|
LEAD |
Whether binding to Leads is enabled. Possible values:
Default is |
|
CONTACT |
Whether binding to Contacts is enabled. Possible values:
Default is |
|
COMPANY |
Whether binding to Companies is enabled. Possible values:
Default is |
|
DEAL |
Whether binding to Deals is enabled. Possible values:
Default is |
Example
from b24pysdk.client import BaseClient
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>
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>';
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 |
Description |
|
result |
Contains |
|
time |
Request execution time information |
Error Handling
HTTP status: 400
{
"error":"",
"error_description":"Access denied."
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
Empty string |
Access denied. |
A field with this |
|
Empty string |
ID is not defined or invalid |
Not specified or an invalid |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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 |