Add Custom Field task.item.userfield.add
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
taskWho can execute the method: administrator
The method task.item.userfield.add creates a custom field for a task.
When creating a custom field, it is mandatory to use the prefix UF_ in the field name FIELD_NAME. If the prefix is not specified, the system will automatically add it to the beginning of the name.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
PARAMS* |
Set of parameters for the created field (detailed description) |
Parameter PARAMS
|
Name |
Description |
|
USER_TYPE_ID* |
Data type of the custom field. Supported values:
|
|
FIELD_NAME* |
Code of the custom field |
|
XML_ID |
External identifier |
|
EDIT_FORM_LABEL |
Label in the edit form (detailed description) |
|
LABEL |
Name of the custom field |
|
SORT |
Sorting |
|
MULTIPLE |
Multiple value. Possible values:
Applies to types |
|
MANDATORY |
Mandatory value. Possible values:
|
|
SETTINGS |
Additional settings for the field type (detailed description) |
Parameter EDIT_FORM_LABEL
|
Name |
Description |
|
de |
Label in German |
|
en |
Label in English |
Parameter SETTINGS
The fields of the SETTINGS object depend on the USER_TYPE_ID type.
|
Name |
Description |
|
DEFAULT_VALUE |
Default value |
|
ROWS |
Number of rows in the input field |
|
Name |
Description |
|
DEFAULT_VALUE |
Default value |
|
Name |
Description |
|
DEFAULT_VALUE |
Default value. Described as an object with two parameters:
|
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"PARAMS": {
"USER_TYPE_ID": "string",
"FIELD_NAME": "UF_TASK_CLIENT_REQUEST",
"XML_ID": "UF_TASK_CLIENT_REQUEST",
"EDIT_FORM_LABEL": {
"de": "Kundenanfrage",
"en": "Client request"
},
"LABEL": "Client request",
"SORT": 220,
"MULTIPLE": "N",
"MANDATORY": "Y",
"SETTINGS": {
"DEFAULT_VALUE": "Clarify the goal and expected result",
"ROWS": 10
}
}
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.item.userfield.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"PARAMS": {
"USER_TYPE_ID": "string",
"FIELD_NAME": "UF_TASK_CLIENT_REQUEST",
"XML_ID": "UF_TASK_CLIENT_REQUEST",
"EDIT_FORM_LABEL": {
"de": "Kundenanfrage",
"en": "Client request"
},
"LABEL": "Client request",
"SORT": 220,
"MULTIPLE": "N",
"MANDATORY": "Y",
"SETTINGS": {
"DEFAULT_VALUE": "Clarify the goal and expected result",
"ROWS": 10
}
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/task.item.userfield.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<number>({
method: 'task.item.userfield.add',
params: {
PARAMS: {
USER_TYPE_ID: 'string',
FIELD_NAME: 'UF_TASK_CLIENT_REQUEST',
XML_ID: 'UF_TASK_CLIENT_REQUEST',
EDIT_FORM_LABEL: {
de: 'Kundenanfrage',
en: 'Client request',
},
LABEL: 'Client request',
SORT: 220,
MULTIPLE: 'N',
MANDATORY: 'Y',
SETTINGS: {
DEFAULT_VALUE: 'Clarify the goal and expected result',
ROWS: 10,
},
},
},
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('Created user field ID:', 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 addTaskUserField() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'task.item.userfield.add',
params: {
PARAMS: {
USER_TYPE_ID: 'string',
FIELD_NAME: 'UF_TASK_CLIENT_REQUEST',
XML_ID: 'UF_TASK_CLIENT_REQUEST',
EDIT_FORM_LABEL: {
de: 'Kundenanfrage',
en: 'Client request',
},
LABEL: 'Client request',
SORT: 220,
MULTIPLE: 'N',
MANDATORY: 'Y',
SETTINGS: {
DEFAULT_VALUE: 'Clarify the goal and expected result',
ROWS: 10,
},
},
},
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('Created user field ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addTaskUserField)
</script>
try {
$response = $b24Service
->core
->call(
'task.item.userfield.add',
[
'PARAMS' => [
'USER_TYPE_ID' => 'string',
'FIELD_NAME' => 'UF_TASK_CLIENT_REQUEST',
'XML_ID' => 'UF_TASK_CLIENT_REQUEST',
'EDIT_FORM_LABEL' => [
'de' => 'Kundenanfrage',
'en' => 'Client request'
],
'LABEL' => 'Client request',
'SORT' => 220,
'MULTIPLE' => 'N',
'MANDATORY' => 'Y',
'SETTINGS' => [
'DEFAULT_VALUE' => 'Clarify the goal and expected result',
'ROWS' => 10
]
]
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'task.item.userfield.add',
{
PARAMS: {
USER_TYPE_ID: 'string',
FIELD_NAME: 'UF_TASK_CLIENT_REQUEST',
XML_ID: 'UF_TASK_CLIENT_REQUEST',
LABEL: 'Client request',
EDIT_FORM_LABEL: {
de: 'Kundenanfrage',
en: 'Client request'
},
SORT: 220,
MULTIPLE: 'N',
MANDATORY: 'Y',
SETTINGS: {
DEFAULT_VALUE: 'Clarify the goal and expected result',
ROWS: 10
}
}
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'task.item.userfield.add',
[
'PARAMS' => [
'USER_TYPE_ID' => 'string',
'FIELD_NAME' => 'UF_TASK_CLIENT_REQUEST',
'XML_ID' => 'UF_TASK_CLIENT_REQUEST',
'EDIT_FORM_LABEL' => [
'de' => 'Kundenanfrage',
'en' => 'Client request'
],
'LABEL' => 'Client request',
'SORT' => 220,
'MULTIPLE' => 'N',
'MANDATORY' => 'Y',
'SETTINGS' => [
'DEFAULT_VALUE' => 'Clarify the goal and expected result',
'ROWS' => 10
]
]
]
);
print_r($result);
Response Handling
HTTP Status: 200
{
"result": 1325,
"time": {
"start": 1772711476,
"finish": 1772711476.284127,
"duration": 0.28412699699401855,
"processing": 0,
"date_start": "2026-03-05T14:51:16+01:00",
"date_finish": "2026-03-05T14:51:16+01:00",
"operating_reset_at": 1772712076,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Identifier of the created custom field |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "ERROR_CORE",
"error_description": "The 'USER_TYPE_ID' field is not found."
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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
|
Status |
Code |
Description |
Value |
|
|
|
The 'USER_TYPE_ID' field is not found |
The parameter |
|
|
|
Invalid user type specified. |
An invalid or non-existent user field type is specified in the |
|
|
|
The 'FIELD_NAME' field is not found |
The parameter |
|
|
|
The field UF_TASK_CLIENT_REQUEST for the object TASKS_TASK already exists. |
The |
|
|
|
Access denied |
Insufficient permissions to create a custom field |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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 |
Continue Learning
- Custom Fields in Tasks: Overview of Methods
- Update User Field task.item.userfield.update
- Get Custom Task Field by ID task.item.userfield.get
- Get a List of Custom Fields task.item.userfield.getlist
- Delete User Field task.item.userfield.delete
- Get a List of Available Data Types for task.item.userfield.gettypes
- Get User Field Fields with task.item.userfield.getfields