Add a Custom Field to the CRM Requisite Template crm.requisite.preset.field.add
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:
crmWho can execute the method: any user
Adds a custom field to a company details template. Use the crm.requisite.preset.field.availabletoadd method to retrieve the fields available for addition to the template.
Before adding a user-defined field UF_... to the template, you must create it using the crm.requisite.userfield.add method or ensure that it already exists.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
preset* |
An object containing the identifier of the template to which the custom field is added (e.g., Template identifiers can be obtained using the method crm.requisite.preset.list |
|
fields* |
A set of fields — an object of the form |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
FIELD_NAME* |
The name of the field. |
|
FIELD_TITLE |
An alternative name for the field in the requisite. The alternative name is displayed in various forms for filling out requisites. Depending on the specific form, the alternative name may or may not be used |
|
SORT |
Sorting. The order in the list of template fields |
|
IN_SHORT_LIST |
Show in the short list. Deprecated field, currently not used. Retained for backward compatibility. Can take values |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"preset":{"ID":27},"fields":{"FIELD_NAME":"RQ_NAME","FIELD_TITLE":"TEST","IN_SHORT_LIST":"N","SORT":580}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.field.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"preset":{"ID":27},"fields":{"FIELD_NAME":"RQ_NAME","FIELD_TITLE":"TEST","IN_SHORT_LIST":"N","SORT":580},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.requisite.preset.field.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.preset.field.add',
params: {
preset: {
ID: 27, // Template ID
},
fields: {
FIELD_NAME: 'RQ_NAME',
FIELD_TITLE: 'TEST',
IN_SHORT_LIST: 'N',
SORT: 580,
},
},
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('Added 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 addPresetField() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.requisite.preset.field.add',
params: {
preset: {
ID: 27, // Template ID
},
fields: {
FIELD_NAME: 'RQ_NAME',
FIELD_TITLE: 'TEST',
IN_SHORT_LIST: 'N',
SORT: 580,
},
},
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('Added field ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addPresetField)
</script>
try {
$response = $b24Service
->core
->call(
'crm.requisite.preset.field.add',
[
'preset' => [
'ID' => 27, // Template ID
],
'fields' => [ // Object with custom field description
'FIELD_NAME' => 'RQ_NAME',
'FIELD_TITLE' => 'TEST',
'IN_SHORT_LIST' => 'N',
'SORT' => 580,
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Custom field with ID has been added to the template ' . $result;
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding custom field: ' . $e->getMessage();
}
Example
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.requisite.preset.field.add(
preset={
"ID": 27,
},
fields={
"FIELD_NAME": "RQ_NAME",
"FIELD_TITLE": "TEST",
"IN_SHORT_LIST": "N",
"SORT": 580,
},
).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}")
BX24.callMethod(
"crm.requisite.preset.field.add",
{
preset:
{
"ID": 27 // Template ID
},
fields: // Object with custom field description
{
"FIELD_NAME": "RQ_NAME",
"FIELD_TITLE": "TEST",
"IN_SHORT_LIST": "N",
"SORT": 580
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.info("Custom field with ID has been added to the template " + result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.requisite.preset.field.add',
[
'preset' => ['ID' => 27],
'fields' => [
'FIELD_NAME' => 'RQ_NAME',
'FIELD_TITLE' => 'TEST',
'IN_SHORT_LIST' => 'N',
'SORT' => 580
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": 3,
"time": {
"start": 1716811635.108203,
"finish": 1716811635.503093,
"duration": 0.39489006996154785,
"processing": 0.043524980545043945,
"date_start": "2024-05-27T14:07:15+02:00",
"date_finish": "2024-05-27T14:07:15+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Identifier of the added field |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 40x, 50x
{
"error": "",
"error_description": "The field 'RQ_NAME' can not be added."
}
|
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 |
|
|
The field cannot be added. The field may already exist in the template or it is not available for the country to which the template belongs |
|
|
Template with the specified identifier not found |
|
|
Insufficient access permissions to add the custom field to the requisite template |
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 |
Continue Learning
- Update Custom Field of a Given Requisite Template crm.requisite.preset.field.update
- Get Fields Available for Addition to the Requisite Template crm.requisite.preset.field.availabletoadd
- Get Custom Field of Requisite Template by ID crm.requisite.preset.field.get
- Get a List of All Customizable Fields for a Specified CRM Requisites Template crm.requisite.preset.field.list
- Delete Custom Field from CRM Requisite Template crm.requisite.preset.field.delete
- Get Description of Custom Fields for the Requisite Template crm.requisite.preset.field.fields