Create a New Custom Field for crm.requisite.userfield.add

Scope: crm

Who can execute the method: any user

This method creates a new custom field for the requisite.

Limitations for the custom field symbolic code

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 `type`	Description
fields* `object`	A set of fields — an object of the form `{"field": "value"[, ...]}` for adding a custom requisite field

Parameter fields

Required parameters are marked with *

Name `type`	Description
ENTITY_ID* `string`	The identifier of the entity to which the custom field belongs. For requisites, this is always `CRM_REQUISITE`
FIELD_NAME* `string`	Symbolic code. For requisites, it always starts with the prefix `UF_CRM_`
USER_TYPE_ID* `string`	Data type (`string`, `boolean`, `double`, or `datetime`)
XML_ID `string`	External key. Used for exchange operations. Identifier of the external information base object. The purpose of the field may change by the final developer
SORT `int`	Sorting
MULTIPLE `char`	Multiplicity indicator. Possible values: `Y` — yes `N` — no Defaults to `N`
MANDATORY `char`	Mandatory indicator. Possible values: `Y` — yes `N` — no Defaults to `N`
SHOW_FILTER `char`	Whether to show in the list filter. Possible values: `N` — do not show `I` — exact match `E` — mask `S` — substring Defaults to `N`
SHOW_IN_LIST `char`	Whether to show in the list. Possible values: `Y` — yes `N` — no Defaults to `Y`
EDIT_IN_LIST `char`	Whether to allow editing by the user. Possible values: `Y` — yes `N` — no Defaults to `Y`
IS_SEARCHABLE `char`	Whether the field values participate in the search. Possible values: `Y` — yes `N` — no Defaults to `N`
EDIT_FORM_LABEL `string`	Label in the edit form
LIST_COLUMN_LABEL `string`	Header in the list
LIST_FILTER_LABEL `string`	Filter label in the list
ERROR_MESSAGE `string`	Error message
HELP_MESSAGE `string`	Help
LIST `uf_enum_element`	List elements. For more details, see the section Get Field Descriptions for Custom Field Type "Enumeration" (List) crm.userfield.enumeration.fields
SETTINGS `object`	Additional settings (dependent on the type). For more details, see the section Get the settings field descriptions for the custom field type crm.userfield.settings.fields

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 '{"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"}}' \
        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 - String","LIST_COLUMN_LABEL":"PP - String","LIST_FILTER_LABEL":"PP - String","FIELD_NAME":"NEWTECH_v1_STRING"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.userfield.add

try
        {
        	const response = await $b24.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 - String",
        				"LIST_COLUMN_LABEL": "PP - String",
        				"LIST_FILTER_LABEL": "PP - String",
        				"FIELD_NAME": "NEWTECH_v1_STRING"
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch(error)
        {
        	console.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 - String',
                            'LIST_COLUMN_LABEL' => 'PP - String',
                            'LIST_FILTER_LABEL' => 'PP - String',
                            '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 - String",
                  "LIST_COLUMN_LABEL": "PP - String",
                  "LIST_FILTER_LABEL": "PP - String",
                  "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 - String',
                    'LIST_COLUMN_LABEL' => 'PP - String',
                    'LIST_FILTER_LABEL' => 'PP - String',
                    'FIELD_NAME' => 'NEWTECH_v1_STRING'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

Error Handling

HTTP status: 40x, 50x

{
            "error": "ERROR_CORE",
            "error_description": "Field UF_CRM_NEWTECH_V1_STRING for object CRM_REQUISITE already exists."
        }

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 Errors

Code	Error Text	Description
`ERROR_CORE`	`Field UF_CRM_NEWTECH_V1_STRING for object CRM_REQUISITE already exists`	Attempt to recreate a custom field with the same symbolic code
Empty string	`The 'USER_TYPE_ID' field is not found`	Data type for the custom field not specified
Empty string	`The 'FIELD_NAME' field is not found`	Symbolic code for the custom field not specified
Empty string	`Access denied`	Insufficient access permissions to add a custom field
`ERROR_CORE`	`Fail to create new user field`	Failed to create a custom field
`ERROR_CORE`	`Fail to save enumeration field values`	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: 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 a Custom Requisite Field

Create a New Custom Field for crm.requisite.userfield.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible ErrorsPossible Errors

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning