Create a New Custom Field For crm.requisite.userfield.add
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
Creates a new custom field for the company details.
Restrictions for the Symbolic Code of the Custom Field
The system limitation for the field name is 20 characters. The custom field name always has the prefix UF_CRM_, meaning the actual length of the name is 13 characters.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
A set of fields — an object of the form |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
ENTITY_ID* |
The identifier of the entity to which the custom field belongs. For requisites, this is always |
|
FIELD_NAME* |
Symbolic code. For requisites, it always starts with the prefix |
|
USER_TYPE_ID* |
|
|
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 |
Multiplicity indicator. Possible values:
Defaults to |
|
MANDATORY |
Mandatory indicator. Possible values:
Defaults to |
|
SHOW_FILTER |
Show in the list filter. Possible values:
Defaults to |
|
SHOW_IN_LIST |
Show in the list. Possible values:
Defaults to |
|
EDIT_IN_LIST |
Allow user editing. Possible values:
Defaults to |
|
IS_SEARCHABLE |
Are field values included in the search. Possible values:
Defaults to |
|
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 '{"fields":{"USER_TYPE_ID":"string","ENTITY_ID":"CRM_REQUISITE","SORT":100,"MULTIPLE":"N","MANDATORY":"N","SHOW_FILTER":"E","SHOW_IN_LIST":"Y","EDIT_FORM_LABEL":"PP - Line","LIST_COLUMN_LABEL":"PP - Line","LIST_FILTER_LABEL":"PP - Line","FIELD_NAME":"NEWTECH_v1_STRING"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.userfield.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"USER_TYPE_ID":"string","ENTITY_ID":"CRM_REQUISITE","SORT":100,"MULTIPLE":"N","MANDATORY":"N","SHOW_FILTER":"E","SHOW_IN_LIST":"Y","EDIT_FORM_LABEL":"PP - Line","LIST_COLUMN_LABEL":"PP - Line","LIST_FILTER_LABEL":"PP - Line","FIELD_NAME":"NEWTECH_v1_STRING"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.userfield.add
// 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<number>({
method: 'crm.requisite.userfield.add',
params: {
fields: {
USER_TYPE_ID: 'string',
ENTITY_ID: 'CRM_REQUISITE',
SORT: 100,
MULTIPLE: 'N',
MANDATORY: 'N',
SHOW_FILTER: 'E',
SHOW_IN_LIST: 'Y',
EDIT_FORM_LABEL: 'PP - String',
LIST_COLUMN_LABEL: 'PP - String',
LIST_FILTER_LABEL: 'PP - String',
FIELD_NAME: 'NEWTECH_v1_STRING',
},
},
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('Created user field ID:', 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 addRequisiteUserField() {
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.add',
params: {
fields: {
USER_TYPE_ID: 'string',
ENTITY_ID: 'CRM_REQUISITE',
SORT: 100,
MULTIPLE: 'N',
MANDATORY: 'N',
SHOW_FILTER: 'E',
SHOW_IN_LIST: 'Y',
EDIT_FORM_LABEL: 'PP - String',
LIST_COLUMN_LABEL: 'PP - String',
LIST_FILTER_LABEL: 'PP - String',
FIELD_NAME: 'NEWTECH_v1_STRING',
},
},
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('Created user field ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addRequisiteUserField)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.requisite.userfield.add(
fields={
"USER_TYPE_ID": "string",
"ENTITY_ID": "CRM_REQUISITE",
"SORT": 100,
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "E",
"SHOW_IN_LIST": "Y",
"EDIT_FORM_LABEL": "PP - Line",
"LIST_COLUMN_LABEL": "PP - Line",
"LIST_FILTER_LABEL": "PP - Line",
"FIELD_NAME": "NEWTECH_v1_STRING",
},
).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(
'crm.requisite.userfield.add',
[
'fields' => [
'USER_TYPE_ID' => 'string',
'ENTITY_ID' => 'CRM_REQUISITE',
'SORT' => 100,
'MULTIPLE' => 'N',
'MANDATORY' => 'N',
'SHOW_FILTER' => 'E',
'SHOW_IN_LIST' => 'Y',
'EDIT_FORM_LABEL' => 'PP - Line',
'LIST_COLUMN_LABEL' => 'PP - Line',
'LIST_FILTER_LABEL' => 'PP - Line',
'FIELD_NAME' => 'NEWTECH_v1_STRING',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding user field: ' . $e->getMessage();
}
BX24.callMethod(
"crm.requisite.userfield.add",
{
fields:
{
"USER_TYPE_ID": "string",
"ENTITY_ID": "CRM_REQUISITE",
"SORT": 100,
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "E",
"SHOW_IN_LIST": "Y",
"EDIT_FORM_LABEL": "PP - Line",
"LIST_COLUMN_LABEL": "PP - Line",
"LIST_FILTER_LABEL": "PP - Line",
"FIELD_NAME": "NEWTECH_v1_STRING"
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.requisite.userfield.add',
[
'fields' => [
'USER_TYPE_ID' => 'string',
'ENTITY_ID' => 'CRM_REQUISITE',
'SORT' => 100,
'MULTIPLE' => 'N',
'MANDATORY' => 'N',
'SHOW_FILTER' => 'E',
'SHOW_IN_LIST' => 'Y',
'EDIT_FORM_LABEL' => 'PP - Line',
'LIST_COLUMN_LABEL' => 'PP - Line',
'LIST_FILTER_LABEL' => 'PP - Line',
'FIELD_NAME' => 'NEWTECH_v1_STRING'
]
]
);
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.add", b24.Params{
"fields": b24.Params{
"USER_TYPE_ID": "string",
"ENTITY_ID": "CRM_REQUISITE",
"SORT": 100,
"MULTIPLE": "N",
"MANDATORY": "N",
"SHOW_FILTER": "E",
"SHOW_IN_LIST": "Y",
"EDIT_FORM_LABEL": "PP - Line",
"LIST_COLUMN_LABEL": "PP - Line",
"LIST_FILTER_LABEL": "PP - Line",
"FIELD_NAME": "NEWTECH_v1_STRING",
},
})
if err != nil {
return fmt.Errorf("crm.requisite.userfield.add: %w", err)
}
var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("id:", newID)
Response Handling
HTTP status: 200
{
"result": 235,
"time": {
"start": 1717681176.885836,
"finish": 1717681177.353738,
"duration": 0.46790218353271484,
"processing": 0.084564208984375,
"date_start": "2024-06-06T15:39:36+02:00",
"date_finish": "2024-06-06T15:39:37+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Identifier of the created custom field |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 40x, 50x
{
"error": "ERROR_CORE",
"error_description": "The field UF_CRM_NEWTECH_V1_STRING for the CRM_REQUISITE object already exists."
}
|
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 |
|
|
|
Attempt to recreate a custom field with the same symbolic code |
|
Empty string |
|
Data type for the custom field is not specified |
|
Empty string |
|
Symbolic code for the custom field is not specified |
|
Empty string |
|
Insufficient access permissions to add a custom field |
|
|
|
Failed to create a 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 |