Add a Custom Field to the CRM Requisite Template crm.requisite.preset.field.add

Scope: crm

Who can execute the method: any user

This method adds a custom field to the requisite template. You can use the method crm.requisite.preset.field.availabletoadd to retrieve the fields available for addition to the template.

Before adding a user-defined field UF_... to the template, it must be created using the method crm.requisite.userfield.add or ensure that it already exists.

Method Parameters

Required parameters are marked with *

Name
type

Description

preset*
object

An object containing the identifier of the template to which the custom field is added (e.g., {"ID": 27}).

Template identifiers can be obtained using the method crm.requisite.preset.list

fields*
object

A set of fields — an object of the form {"field": "value"[, ...]} for adding the custom field to the template

Fields Parameter

Required parameters are marked with *

Name `type`	Description
FIELD_NAME* `string`	The name of the field.
FIELD_TITLE `string`	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 `integer`	Sorting. The order in the list of template fields
IN_SHORT_LIST `char`	Show in the short list. Deprecated field, currently not used. Retained for backward compatibility. Can take values `Y` or `N`

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
        	const response = await $b24.callMethod(
        		"crm.requisite.preset.field.add",
        		{
        			preset:
        			{
        				"ID": 27    // Template identifier
        			},
        			fields:        // Object describing the custom field
        			{
        				"FIELD_NAME": "RQ_NAME",
        				"FIELD_TITLE": "TEST",
        				"IN_SHORT_LIST": "N",
        				"SORT": 580
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info("Custom field with ID " + result + " added to the template");
        }
        catch(error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.preset.field.add',
                    [
                        'preset' => [
                            'ID' => 27, // Template identifier
                        ],
                        'fields' => [ // Object describing the custom field
                            'FIELD_NAME'    => 'RQ_NAME',
                            'FIELD_TITLE'   => 'TEST',
                            'IN_SHORT_LIST' => 'N',
                            'SORT'          => 580,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Custom field with ID ' . $result . ' added to the template';
        
        } 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 identifier
                },
                fields:        // Object describing the custom field
                {
                    "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 " + result.data() + " added to the template");
            }
        );

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 `type`	Description
result `integer`	Identifier of the added field
time `time`	Information about the request execution time

Error Handling

HTTP Status: 40x, 50x

{
            "error": "",
            "error_description": "The field 'RQ_NAME' cannot be added."
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `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 'RQ_NAME' cannot be added`	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
`The Preset with ID '27' is not found`	Template with the specified identifier not found
`Access denied`	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 Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of Methods

Update Custom Field of a Given Requisite Template

Add a Custom Field to the CRM Requisite Template crm.requisite.preset.field.add

Method ParametersMethod Parameters

Fields ParameterFields Parameter

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning