Add Custom Field task.item.userfield.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:
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
params = {
"USER_TYPE_ID": "string",
"FIELD_NAME": "UF_TASK_CLIENT_REQUEST",
"XML_ID": "UF_TASK_CLIENT_REQUEST",
"EDIT_FORM_LABEL": {
"ru": "Client request",
"en": "Client request",
},
"LABEL": "Client request",
"SORT": 220,
"MULTIPLE": "N",
"MANDATORY": "Y",
"SETTINGS": {
"DEFAULT_VALUE": "Clarify the goal and the expected result",
"ROWS": 10,
},
}
try:
bitrix_response = client.task.item.userfield.add(
params=params,
).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(
'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);
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "task.item.userfield.add", b24.Params{
"PARAMS": b24.Params{
"USER_TYPE_ID": "string",
"FIELD_NAME": "UF_TASK_CLIENT_REQUEST",
"XML_ID": "UF_TASK_CLIENT_REQUEST",
"EDIT_FORM_LABEL": b24.Params{
"en": "Client request",
},
"LABEL": "Client request",
"SORT": 220,
"MULTIPLE": "N",
"MANDATORY": "Y",
"SETTINGS": b24.Params{
"DEFAULT_VALUE": "Clarify the goal and expected result",
"ROWS": 10,
},
},
})
if err != nil {
return fmt.Errorf("task.item.userfield.add: %w", err)
}
var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("id:", newID)
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 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 |
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: 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 |
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