Create a Custom Field for Contacts crm.contact.userfield.add

Scope: crm

Who can execute the method: administrator

The method crm.contact.userfield.add creates a new custom field for contacts.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

Object format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }

where:

field_n — field name
value_n — field value

The list of available fields is described below.

An incorrect field in fields will be ignored

Parameter fields

Required parameters are marked with *

Name `type`	Description
USER_TYPE_ID* `string`	The data type of the custom field. Possible values: `string` — string `integer` — integer `double` — number `boolean` — yes/no `datetime` — date/time `date` — date `money` — money `url` — link `address` — address `enumeration` — list `file` — file `employee` — link to employee `crm_status` — link to CRM directory `iblock_section` — link to information block sections `iblock_element` — link to information block elements `crm` — link to CRM elements custom field types
FIELD_NAME* `string`	Field code. Unique. The system limit for the field code is 20 characters. The prefix `UF_CRM_` is always added to the custom field name, meaning the actual length of the name is 13 characters. Allowed characters: `A-Z`, `0-9`, and `_`
LABEL `string`	Default name of the custom field. The provided value will be set in the following fields: `LIST_FILTER_LABEL`, `LIST_COLUMN_LABEL`, `EDIT_FORM_LABEL`, `ERROR_MESSAGE`, `HELP_MESSAGE`, if no value is provided for them
XML_ID `string`	External code
LIST_FILTER_LABEL `string`\|`lang_map`	Filter label in the list. When a string is provided, it will be set for all language identifiers. When a `lang_map` type value is provided, the value from `LABEL` will be set for all languages not provided. By default, the value passed in `LABEL` is set for all language identifiers
LIST_COLUMN_LABEL `string`\|`lang_map`	Header in the list. When a string is provided, it will be set for all language identifiers. When a `lang_map` type value is provided, the value from `LABEL` will be set for all languages not provided. By default, the value passed in `LABEL` is set for all language identifiers
EDIT_FORM_LABEL `string`\|`lang_map`	Label in the edit form. When a string is provided, it will be set for all language identifiers. When a `lang_map` type value is provided, the value from `LABEL` will be set for all languages not provided. By default, the value passed in `LABEL` is set for all language identifiers
ERROR_MESSAGE `string`\|`lang_map`	Error message. When a string is provided, it will be set for all language identifiers. When a `lang_map` type value is provided, the value from `LABEL` will be set for all languages not provided. By default, the value passed in `LABEL` is set for all language identifiers
HELP_MESSAGE `string`\|`lang_map`	Help. When a string is provided, it will be set for all language identifiers. When a `lang_map` type value is provided, the value from `LABEL` will be set for all languages not provided. By default, the value passed in `LABEL` is set for all language identifiers
MULTIPLE `boolean`	Is the field multiple. Possible values: `Y` — yes `N` — no Fields of type `boolean` cannot be multiple. By default `N`
MANDATORY `boolean`	Is the field mandatory. Possible values: `Y` — yes `N` — no By default `N`
SHOW_FILTER `boolean`	Show the field in the filter. Possible values: `Y` — yes `N` — no By default `N`
SETTINGS `object`	Additional field parameters. Each field type (`USER_TYPE_ID`) has its own set of available settings, which are described below
LIST `uf_enum_element[]`	List of possible values for the custom field of type `enumeration`. For custom fields of other types, this parameter is meaningless. By default `[]`
SORT `integer`	Sort index. Must be greater than zero. By default `100`
SHOW_IN_LIST `boolean`	Show the custom field in the list. This parameter has no effect within `crm`. Possible values: `Y` — yes `N` — no By default `N`
EDIT_IN_LIST `boolean`	Allow user editing. Possible values: `Y` — yes `N` — no By default `Y`
IS_SEARCHABLE `boolean`	Are the field values included in the search. This parameter has no effect within `crm`. Possible values: `Y` — yes `N` — no By default `N`

Parameter SETTINGS

Each type of custom field has its own set of additional settings. This method only supports those described below.

string

integer

double

boolean

date|datetime

enumeration

iblock_section|iblock_element

crm_status

crm

Name
type

Description

DEFAULT_VALUE
string

Default value.

By default ''

ROWS
integer

Number of rows in the input field. Must be greater than 0.

By default 1

Name `type`	Description
DEFAULT_VALUE `integer`	Default value

Name
type

Description

DEFAULT_VALUE
double

Default value

PRECISION
integer

Number precision. Must be greater than or equal to 0.

By default 2

Name
type

Description

DEFAULT_VALUE
integer

Default value, where 1 — yes, 0 — no.

Possible values:

>= 1 -> 1
<= 0 -> 0

By default 0

DISPLAY
string

Appearance. Possible values:

CHECKBOX — checkbox
RADIO — radio buttons
DROPDOWN — dropdown list

By default CHECKBOX

Name
type

Description

DEFAULT_VALUE
object

Default value.

Object format:

{
            VALUE: datetime|date,
            TYPE: 'NONE'|'NOW'|'FIXED',
        }

where:

VALUE — default value of type datetime or date
TYPE — type of default value:
- NONE — do not set a default value
- NOW — use the current time/date
- FIXED — use the time/date from VALUE

Default value:

{
            VALUE: '',
            TYPE: 'NONE',
        }

Name
type

Description

DISPLAY
string

Appearance. Possible values:

LIST — list
UI — input list
CHECKBOX — checkboxes
DIALOG — entity selection dialog

By default LIST

LIST_HEIGHT

Height of the list. Must be greater than 0.

Available only when DISPLAY = LIST or DISPLAY = UI.

By default 1

Name `type`	Description
IBLOCK_TYPE_ID `string`	Identifier of the information block type. By default `''`
IBLOCK_ID `string`	Identifier of the information block. By default `0`
DEFAULT_VALUE `string`	Default value. By default `''`
DISPLAY `string`	Appearance. Possible values: `DIALOG` — dialog `UI` — input list `LIST` — list `CHECKBOX` — checkboxes By default `LIST`
LIST_HEIGHT `integer`	Height of the list. Must be greater than 0. By default `1`
ACTIVE_FILTER `boolean`	Show elements with the active flag enabled. Possible values: `Y` — yes `N` — no By default `N`

Name
type

Description

ENTITY_TYPE
string

Identifier of the directory type.

Use crm.status.entity.types to find possible values.

By default ''

If none of the following options are provided, the link to leads will be enabled by default (LEAD = Y).

Name `type`	Description
LEAD `boolean`	Is the link to Leads enabled. Possible values: `Y` — yes `N` — no By default `N`
CONTACT `boolean`	Is the link to Contacts enabled. Possible values: `Y` — yes `N` — no By default `N`
COMPANY `boolean`	Is the link to Companies enabled. Possible values: `Y` — yes `N` — no By default `N`
DEAL `boolean`	Is the link to Deals enabled. Possible values: `Y` — yes `N` — no By default `N`

Type uf_enum_element

Name `type`	Description
VALUE `string`	Value of the list element. List elements with an empty or missing `VALUE` will be ignored
SORT `integer`	Sort index. Must be greater than or equal to 0. By default `0`
DEF `boolean`	Is the list element the default value. Possible values: `Y` — yes `N` — no For a multiple field, multiple `DEF = Y` are allowed. For a non-multiple field, the first provided list element with `DEF = Y` will be considered the default value. By default `N`
XML_ID `string`	External code of the value. Must be unique within the list elements of the custom field

Code Examples

How to Use Examples in Documentation

Example of Creating a String Type Custom Field

cURL (Webhook)

cURL (OAuth)

PHP

PHP (B24PhpSdk)

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"LABEL":"Field \'Hello, World!\'","USER_TYPE_ID":"string","FIELD_NAME":"HELLO_WORLD","MULTIPLE":"Y","MANDATORY":"Y","SHOW_FILTER":"Y","SETTINGS":{"DEFAULT_VALUE":"Hello, World! Default value","ROWS":3},"SORT":1000,"EDIT_IN_LIST":"Y","LIST_FILTER_LABEL":"Hello, World! Filter","LIST_COLUMN_LABEL":{"en":"Hello, World! Column","de":"Hallo, Welt! Spalte"},"EDIT_FORM_LABEL":{"en":"Hello, World! Edit","de":"Hallo, Welt! Bearbeiten"},"ERROR_MESSAGE":{"en":"Hello, World! Error","de":"Hallo, Welt! Fehler"},"HELP_MESSAGE":{"en":"Hello, World! Help","de":"Hallo, Welt! Hilfe"}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.userfield.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"LABEL":"Field \'Hello, World!\'","USER_TYPE_ID":"string","FIELD_NAME":"HELLO_WORLD","MULTIPLE":"Y","MANDATORY":"Y","SHOW_FILTER":"Y","SETTINGS":{"DEFAULT_VALUE":"Hello, World! Default value","ROWS":3},"SORT":1000,"EDIT_IN_LIST":"Y","LIST_FILTER_LABEL":"Hello, World! Filter","LIST_COLUMN_LABEL":{"en":"Hello, World! Column","de":"Hallo, Welt! Spalte"},"EDIT_FORM_LABEL":{"en":"Hello, World! Edit","de":"Hallo, Welt! Bearbeiten"},"ERROR_MESSAGE":{"en":"Hello, World! Error","de":"Hallo, Welt! Fehler"},"HELP_MESSAGE":{"en":"Hello, World! Help","de":"Hallo, Welt! Hilfe"}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.contact.userfield.add

BX24.callMethod(
            'crm.contact.userfield.add',
            {
                fields: {
                    LABEL: "Field \'Hello, World!\'",
                    USER_TYPE_ID: "string",
                    FIELD_NAME: "HELLO_WORLD",
                    MULTIPLE: "Y",
                    MANDATORY: "Y",
                    SHOW_FILTER: "Y",
                    SETTINGS: {
                        DEFAULT_VALUE: "Hello, World! Default value",
                        ROWS: 3,
                    },
                    SORT: 1000,
                    EDIT_IN_LIST: "Y",
                    LIST_FILTER_LABEL: "Hello, World! Filter",
                    LIST_COLUMN_LABEL: {
                        "en": "Hello, World! Column",
                        "de": "Hallo, Welt! Spalte"
                    },
                    EDIT_FORM_LABEL: {
                        "en": "Hello, World! Edit",
                        "de": "Hallo, Welt! Bearbeiten"
                    },
                    ERROR_MESSAGE: {
                        "en": "Hello, World! Error",
                        "de": "Hallo, Welt! Fehler"
                    },
                    HELP_MESSAGE: {
                        "en": "Hello, World! Help",
                        "de": "Hallo, Welt! Hilfe"
                    },
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.contact.userfield.add',
            [
                'fields' => [
                    'LABEL' => "Field 'Hello, World!'",
                    'USER_TYPE_ID' => "string",
                    'FIELD_NAME' => "HELLO_WORLD",
                    'MULTIPLE' => "Y",
                    'MANDATORY' => "Y",
                    'SHOW_FILTER' => "Y",
                    'SETTINGS' => [
                        'DEFAULT_VALUE' => "Hello, World! Default value",
                        'ROWS' => 3,
                    ],
                    'SORT' => 1000,
                    'EDIT_IN_LIST' => "Y",
                    'LIST_FILTER_LABEL' => "Hello, World! Filter",
                    'LIST_COLUMN_LABEL' => [
                        'en' => "Hello, World! Column",
                        'de' => "Hallo, Welt! Spalte"
                    ],
                    'EDIT_FORM_LABEL' => [
                        'en' => "Hello, World! Edit",
                        'de' => "Hallo, Welt! Bearbeiten"
                    ],
                    'ERROR_MESSAGE' => [
                        'en' => "Hello, World! Error",
                        'de' => "Hallo, Welt! Fehler"
                    ],
                    'HELP_MESSAGE' => [
                        'en' => "Hello, World! Help",
                        'de' => "Hallo, Welt! Hilfe"
                    ],
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

try {
            $userfieldItemFields = [
                'FIELD_NAME' => 'UF_CRM_example',
                'USER_TYPE_ID' => 'string',
                'XML_ID' => 'xml_example',
                'SORT' => '100',
                'MULTIPLE' => 'N',
                'MANDATORY' => 'Y',
                'SHOW_FILTER' => 'Y',
                'SHOW_IN_LIST' => 'Y',
                'EDIT_IN_LIST' => 'Y',
                'IS_SEARCHABLE' => 'Y',
                'EDIT_FORM_LABEL' => 'Example Field',
                'LIST_COLUMN_LABEL' => 'Example Column',
                'LIST_FILTER_LABEL' => 'Example Filter',
                'ERROR_MESSAGE' => 'Error occurred',
                'HELP_MESSAGE' => 'Help message',
                'LIST' => 'list_value',
                'SETTINGS' => 'settings_value',
            ];
        
            $result = $serviceBuilder
                ->getCRMScope()
                ->contactUserfield()
                ->add($userfieldItemFields);
        
            print($result->getId());
        } catch (Throwable $e) {
            print('Error: ' . $e->getMessage());
        }

Example of Creating a List Type Custom Field

cURL (Webhook)

cURL (OAuth)

PHP

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"LABEL":"Custom Field (list)","USER_TYPE_ID":"enumeration","FIELD_NAME":"ENUMERATION_EXAMPLE","MULTIPLE":"N","MANDATORY":"N","SHOW_FILTER":"Y","LIST":[{"VALUE":"List Item #1","DEF":"Y","XML_ID":"XML_ID_1","SORT":100},{"VALUE":"List Item #2","XML_ID":"XML_ID_2","SORT":200},{"VALUE":"List Item #3","XML_ID":"XML_ID_3","SORT":300},{"VALUE":"List Item #4","XML_ID":"XML_ID_4","SORT":400}],"SETTINGS":{"DISPLAY":"UI","LIST_HEIGHT":2},"SORT":2000}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.userfield.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"LABEL":"Custom Field (list)","USER_TYPE_ID":"enumeration","FIELD_NAME":"ENUMERATION_EXAMPLE","MULTIPLE":"N","MANDATORY":"N","SHOW_FILTER":"Y","LIST":[{"VALUE":"List Item #1","DEF":"Y","XML_ID":"XML_ID_1","SORT":100},{"VALUE":"List Item #2","XML_ID":"XML_ID_2","SORT":200},{"VALUE":"List Item #3","XML_ID":"XML_ID_3","SORT":300},{"VALUE":"List Item #4","XML_ID":"XML_ID_4","SORT":400}],"SETTINGS":{"DISPLAY":"UI","LIST_HEIGHT":2},"SORT":2000},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.contact.userfield.add

BX24.callMethod(
            'crm.contact.userfield.add',
            {
                fields: {
                    LABEL: "Custom Field (list)",
                    USER_TYPE_ID: "enumeration",
                    FIELD_NAME: "ENUMERATION_EXAMPLE",
                    MULTIPLE: "N",
                    MANDATORY: "N",
                    SHOW_FILTER: "Y",
                    LIST: [
                        {
                            VALUE: "List Item #1",
                            DEF: "Y",
                            XML_ID: "XML_ID_1",
                            SORT: 100,
                        },
                        {
                            VALUE: "List Item #2",
                            XML_ID: "XML_ID_2",
                            SORT: 200,
                        },
                        {
                            VALUE: "List Item #3",
                            XML_ID: "XML_ID_3",
                            SORT: 300,
                        },
                        {
                            VALUE: "List Item #4",
                            XML_ID: "XML_ID_4",
                            SORT: 400,
                        },
                    ],
                    SETTINGS: {
                        DISPLAY: "UI",
                        LIST_HEIGHT: 2,
                    },
                    SORT: 2000,
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.contact.userfield.add',
            [
                'fields' => [
                    'LABEL' => "Custom Field (list)",
                    'USER_TYPE_ID' => "enumeration",
                    'FIELD_NAME' => "ENUMERATION_EXAMPLE",
                    'MULTIPLE' => "N",
                    'MANDATORY' => "N",
                    'SHOW_FILTER' => "Y",
                    'LIST' => [
                        [
                            'VALUE' => "List Item #1",
                            'DEF' => "Y",
                            'XML_ID' => "XML_ID_1",
                            'SORT' => 100,
                        ],
                        [
                            'VALUE' => "List Item #2",
                            'XML_ID' => "XML_ID_2",
                            'SORT' => 200,
                        ],
                        [
                            'VALUE' => "List Item #3",
                            'XML_ID' => "XML_ID_3",
                            'SORT' => 300,
                        ],
                        [
                            'VALUE' => "List Item #4",
                            'XML_ID' => "XML_ID_4",
                            'SORT' => 400,
                        ],
                    ],
                    'SETTINGS' => [
                        'DISPLAY' => "UI",
                        'LIST_HEIGHT' => 2,
                    ],
                    'SORT' => 2000,
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": 399,
            "time": {
                "start": 1724239307.903115,
                "finish": 1724239308.567422,
                "duration": 0.6643068790435791,
                "processing": 0.20090818405151367,
                "date_start": "2024-08-21T13:21:47+02:00",
                "date_finish": "2024-08-21T13:21:48+02:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `integer`	Root element of the response, contains the identifier of the created custom field
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

This method may return errors not immediately, but by collecting several and concatenating them into a string: \n.

{
            "error": "",
            "error_description": "The 'USER_TYPE_ID' field is not found."
        }

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

Description	Value
`Access denied`	The user does not have administrative rights
`The 'FIELD_NAME' field is not found`	Either an empty `FIELD_NAME` was provided, or it was not provided at all
Field name is too long (more than 50 characters)	The provided `FIELD_NAME` contains more than 50 characters
Field name contains invalid characters. Allowed are: `A-Z`, `0-9`, and `_`	The provided `FIELD_NAME` contains invalid characters
`The 'USER_TYPE_ID' field is not found`	Either an empty `USER_TYPE_ID` was provided, or it was not provided at all
Invalid user type specified	The provided `USER_TYPE_ID` does not exist
List item with XML_ID=`XML_ID` already exists	The provided `XML_ID` in list items are not unique

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

Modify an Existing Custom Field for Contacts

Create a Custom Field for Contacts crm.contact.userfield.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Parameter SETTINGSParameter SETTINGS

Type uf_enum_elementType uf_enum_element

Code ExamplesCode Examples

Example of Creating a String Type Custom FieldExample of Creating a String Type Custom Field

Example of Creating a List Type Custom FieldExample of Creating a List Type Custom Field

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

Method Parameters

Parameter fields

Parameter SETTINGS

Type uf_enum_element

Code Examples

Example of Creating a String Type Custom Field

Example of Creating a List Type Custom Field

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning