Register a New User Field Type userfieldtype.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:
placementWho can execute the method: administrator
The userfieldtype.add method registers an application's user field type and works only in the context of an application. After registration, create a field of this type using the userfieldconfig.add method: pass the full code rest_<APP_ID>_<USER_TYPE_ID> in field.userTypeId, where APP_ID is the application identifier from the app.info method. To create a field, the application also needs the userfieldconfig and crm scopes.
A custom type is needed when a field must display the application interface, for example, data from an external service. For plain text, a number, or a list, standard field types are sufficient.
When a user opens a card with a field of this type, Bitrix24 loads the HANDLER address in the field frame and passes the field and item data in PLACEMENT_OPTIONS. Example for a field in a deal card:
{
"MODE": "view",
"ENTITY_ID": "CRM_DEAL",
"FIELD_NAME": "UF_CRM_DCTEST",
"ENTITY_VALUE_ID": "22",
"VALUE": "Field value",
"MULTIPLE": "N",
"MANDATORY": "N",
"XML_ID": null,
"ENTITY_DATA": {
"entityTypeId": 2,
"entityId": "22",
"module": "crm"
},
"URI": "/crm/deal/details/22/?IFRAME=Y&IFRAME_TYPE=SIDE_SLIDER"
}
What each key means and what else the request contains is described in the section What the Handler Receives.
The handler loads in the field only after the application installation is complete. You can check this by the INSTALLED value in the response of the app.info method.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
USER_TYPE_ID* |
Type code. The method converts it to lowercase. The code must be unique among the types of all applications in Bitrix24: if it is already taken, the method returns the The full type code |
|
HANDLER* |
Handler address that Bitrix24 loads into the field. It must start with Each type of the application must have its own address: if the address is already taken, the method returns the For Bitrix24 over HTTPS, use an HTTPS address, otherwise the browser will not load the field content |
|
TITLE |
Type name, up to 255 characters. Displayed in the administrative interface for configuring custom fields. If not passed, the type code becomes the name |
|
DESCRIPTION |
Type description, up to 255 characters. Displayed in the administrative interface for configuring custom fields |
|
OPTIONS |
Additional settings. Currently, one key is available: Default — |
|
LANG_ALL |
Type name and description for different languages. The object key is a two-letter language code, for example The method retains all supplied translations. userfieldtype.list returns one version of the name and description, selected during registration: the version in the Bitrix24 language if supplied, or another supplied version otherwise |
Code Examples
How to Use Examples in Documentation
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
// 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<boolean>({
method: 'userfieldtype.add',
params: {
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,
},
},
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('Registration result:', 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 addUserFieldType() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'userfieldtype.add',
params: {
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,
},
},
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('Registration result:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addUserFieldType)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
options = {
"height": 60,
}
try:
bitrix_response = client.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=options,
).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(
'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();
echo 'Success: ' . var_export($result[0], 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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "userfieldtype.add", b24.Params{
"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": b24.Params{
"height": 60,
},
})
if err != nil {
return fmt.Errorf("userfieldtype.add: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("done:", ok)
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 |
Description |
|
result |
Result of registering the new user field type |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error":"ERROR_CORE",
"error_description":"Unable to set placement handler: Handler already binded"
}
|
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
|
Status |
Code |
Description |
Meaning |
|
|
|
Current authorization type is denied for this method Application context required |
The method was called outside an application, for example via a webhook |
|
|
|
Access denied! |
The method was called by a user who is not an administrator |
|
|
|
Unable to set placement handler: Handler already binded |
|
|
|
|
Error: The length of "TITLE" should not exceed 255 characters |
The name, description, or language code is longer than allowed. The method creates a type record before the error occurs, and the record appears in userfieldtype.list, but the registration is not complete — a field with this type cannot be created. Delete the type using the userfieldtype.delete method and register it again |
|
|
|
Argument 'USER_TYPE_ID' is null or empty |
|
|
|
|
Argument 'HANDLER' is null or empty |
|
|
|
|
Wrong handler URL |
|
|
|
|
Unsupported handler protocol |
The host name in |
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 |