Register a new user field type userfieldtype.add

Scope: depending on the embedding location

Who can execute the method: any user

The userfieldtype.add method registers a new type of custom fields. After registering the type, create a custom field using the userfieldconfig.add method.

When opening a card with a custom type field, an array PLACEMENT_OPTIONS containing data about the field and entity is passed to the application handler.

{
            "MODE": "view",
            "ENTITY_ID": "CRM_DEAL",
            "FIELD_NAME": "UF_CRM_TEST_TYPE_1",
            "ENTITY_VALUE_ID": "7303",
            "VALUE": null,
            "MULTIPLE": "N",
            "MANDATORY": "N",
            "XML_ID": null,
            "ENTITY_DATA": {
                "entityTypeId": 2,
                "entityId": "7303",
                "module": "crm"
            }
        }

Method Parameters

Required parameters are marked with *

Name `type`	Description	Restrictions
USER_TYPE_ID* `string`	String code for the type	a-z0-9 must be unique
HANDLER* `URL`	Address of the user type handler	in the same domain as the main application address must be unique
TITLE `string`	Text name of the type. Will be displayed in the administrative interface for user field settings
DESCRIPTION `string`	Text description of the type. Will be displayed in the administrative interface for user field settings
OPTIONS `array`	Additional settings. Currently, one key is available: `height` — specifies the height of the user field in pixels. Any positive value will apply. Default is `0`. If `0` is specified, the standard height for displaying this embedding will be used

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 '{
            "USER_TYPE_ID": "test_type",
            "HANDLER": "https://www.myapplication.com/handler/",
            "TITLE": "Updated test type",
            "DESCRIPTION": "Test userfield type for documentation with updated description",
            "OPTIONS": {
                "height": 60
            }
        }' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/userfieldtype.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "USER_TYPE_ID": "test_type",
            "HANDLER": "https://www.myapplication.com/handler/",
            "TITLE": "Updated test type",
            "DESCRIPTION": "Test userfield type for documentation with updated description",
            "OPTIONS": {
                "height": 60
            },
            "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/userfieldtype.add

try
        {
        	const response = await $b24.callMethod(
        		'userfieldtype.add',
        		{
        			USER_TYPE_ID: 'test_type',
        			HANDLER: 'https://www.myapplication.com/handler/',
        			TITLE: 'Updated test type',
        			DESCRIPTION: 'Test userfield type for documentation with updated description',
        			OPTIONS: {
        				height: 60,
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'userfieldtype.add',
                    [
                        'USER_TYPE_ID' => 'test_type',
                        'HANDLER'      => 'https://www.myapplication.com/handler/',
                        'TITLE'        => 'Updated test type',
                        'DESCRIPTION'  => 'Test userfield type for documentation with updated description',
                        'OPTIONS'      => [
                            'height' => 60,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding user field type: ' . $e->getMessage();
        }

BX24.callMethod(
            'userfieldtype.add',
            {
                USER_TYPE_ID: 'test_type',
                HANDLER: 'https://www.myapplication.com/handler/',
                TITLE: 'Updated test type',
                DESCRIPTION: 'Test userfield type for documentation with updated description',
                OPTIONS: {
                    height: 60,
                },
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'userfieldtype.add',
            [
                'USER_TYPE_ID' => 'test_type',
                'HANDLER' => 'https://www.myapplication.com/handler/',
                'TITLE' => 'Updated test type',
                'DESCRIPTION' => 'Test userfield type for documentation with updated description',
                'OPTIONS' => [
                    'height' => 60
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result":true,
            "time":{
                "start":1724421710.397825,
                "finish":1724421711.040353,
                "duration":0.6425280570983887,
                "processing":5.888938903808594e-5,
                "date_start":"2024-08-23T16:01:50+02:00",
                "date_finish":"2024-08-23T16:01:51+02:00","operating":0
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Result of registering the new user field type
time `time`	Information about the execution time of the request

Error Handling

HTTP status: 400

{
            "error":"ERROR_CORE",
            "error_description":"Unable to set placement handler: Handler already binded"
        }

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	Error Message	Description
`ERROR_CORE`	Unable to set placement handler: Handler already binded	`HANDLER` is already occupied by another user field type of this application or `USER_TYPE_ID` is already used by another application
`ERROR_ARGUMENT`	Argument 'USER_TYPE_ID' is null or empty	`USER_TYPE_ID` is not specified
`ERROR_ARGUMENT`	Argument 'HANDLER' is null or empty	`HANDLER` is not specified

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 Custom Field Type Settings

Register a new user field type userfieldtype.add

Method ParametersMethod Parameters

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