Update Custom Field of CRM Requisite crm.requisite.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:
crmWho can execute the method: administrator, user with the "Allow to modify settings" access permission in CRM
Updates an existing custom field of the company details.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the user field. Can be obtained using the method crm.requisite.userfield.list |
|
fields* |
Set of fields — an object of the form |
Parameter fields
|
Name |
Description |
|
XML_ID |
External key. Used for exchange operations. Identifier of the object in the external information base. The purpose of the field may change by the final developer |
|
SORT |
Sorting |
|
MULTIPLE |
Indicator of multiplicity. Possible values:
|
|
MANDATORY |
Indicator of mandatory status. Possible values:
|
|
SHOW_FILTER |
Show in the list filter. Possible values:
|
|
SHOW_IN_LIST |
Whether to show in the list. Possible values:
|
|
EDIT_IN_LIST |
Allow user editing? Possible values:
|
|
IS_SEARCHABLE |
Whether the field values participate in search. Possible values:
|
|
EDIT_FORM_LABEL |
Label in the edit form |
|
LIST_COLUMN_LABEL |
Header in the list |
|
LIST_FILTER_LABEL |
Filter label in the list |
|
ERROR_MESSAGE |
Error message |
|
HELP_MESSAGE |
Help |
|
LIST |
List elements. For detailed information, see the section Get Field Descriptions for Custom Field Type "Enumeration" (List) crm.userfield.enumeration.fields |
|
SETTINGS |
Additional settings (dependent on type). For detailed information, see the section Get Field Settings Description for Custom Field Type crm.userfield.settings.fields |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":235,"fields":{"EDIT_FORM_LABEL":"Category","LIST_COLUMN_LABEL":"Category","LIST_FILTER_LABEL":"Category"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.userfield.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":235,"fields":{"EDIT_FORM_LABEL":"Category","LIST_COLUMN_LABEL":"Category","LIST_FILTER_LABEL":"Category"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.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
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'crm.requisite.userfield.update',
params: {
id: 235,
fields: {
EDIT_FORM_LABEL: 'Category',
LIST_COLUMN_LABEL: 'Category',
LIST_FILTER_LABEL: 'Category',
},
},
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 updateRequisiteUserField() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.requisite.userfield.update',
params: {
id: 235,
fields: {
EDIT_FORM_LABEL: 'Category',
LIST_COLUMN_LABEL: 'Category',
LIST_FILTER_LABEL: 'Category',
},
},
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', updateRequisiteUserField)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.requisite.userfield.update(
bitrix_id=235,
fields={
"EDIT_FORM_LABEL": "Category",
"LIST_COLUMN_LABEL": "Category",
"LIST_FILTER_LABEL": "Category",
},
).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}")
$title = "Category";
try {
$response = $b24Service
->core
->call(
'crm.requisite.userfield.update',
[
'id' => 235,
'fields' => [
'EDIT_FORM_LABEL' => $title,
'LIST_COLUMN_LABEL' => $title,
'LIST_FILTER_LABEL' => $title
]
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating user field: ' . $e->getMessage();
}
const title = "Category";
BX24.callMethod(
"crm.requisite.userfield.update",
{
id: 235,
fields:
{
"EDIT_FORM_LABEL": title,
"LIST_COLUMN_LABEL": title,
"LIST_FILTER_LABEL": title
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
{
console.info(result.data());
}
}
);
require_once('crest.php');
$title = "Category";
$result = CRest::call(
'crm.requisite.userfield.update',
[
'id' => 235,
'fields' =>
[
'EDIT_FORM_LABEL' => $title,
'LIST_COLUMN_LABEL' => $title,
'LIST_FILTER_LABEL' => $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, "crm.requisite.userfield.update", b24.Params{
"id": 235,
"fields": b24.Params{
"EDIT_FORM_LABEL": "Category",
"LIST_COLUMN_LABEL": "Category",
"LIST_FILTER_LABEL": "Category",
},
})
if err != nil {
return fmt.Errorf("crm.requisite.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": 1717769551.504986,
"finish": 1717769551.817433,
"duration": 0.31244707107543945,
"processing": 0.04784202575683594,
"date_start": "2024-06-07T16:12:31+02:00",
"date_finish": "2024-06-07T16:12:31+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Result of updating the custom field:
|
|
time |
Information about the request execution time |
Error Handling
HTTP status: 40x, 50x
{
"error": "",
"error_description": "The entity with ID '235' is not found."
}
|
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
|
Code |
Error text |
Description |
|
Empty string |
|
The user field with the specified identifier was not found |
|
Empty string |
|
The user field with the specified identifier was not found |
|
Empty string |
|
The identifier of the user field is not specified or has an invalid value |
|
Empty string |
|
Insufficient access rights to modify the custom field |
|
|
|
Failed to update the custom field |
|
|
|
Failed to save values for the custom list-type field (e.g., when there is a duplication of the external key of one of the values) |
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 |