Add a Custom Field to the CRM Requisite Template crm.requisite.preset.field.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: a user with "add" access permission for both contacts and companies
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
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}")
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();
}
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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.requisite.preset.field.add", b24.Params{
"preset": b24.Params{
"ID": 27,
},
"fields": b24.Params{
"FIELD_NAME": "RQ_NAME",
"FIELD_TITLE": "TEST",
"IN_SHORT_LIST": "N",
"SORT": 580,
},
})
if err != nil {
return fmt.Errorf("crm.requisite.preset.field.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": 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 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 |
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: 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 |
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