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: task

Who 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
type

Description

PARAMS*
object

Set of parameters for the created field (detailed description)

Parameter PARAMS

Name
type

Description

USER_TYPE_ID*
string

Data type of the custom field.

Supported values:

  • string — string
  • double — number
  • datetime — date and time
  • boolean — yes/no

FIELD_NAME*
string

Code of the custom field

XML_ID
string

External identifier

EDIT_FORM_LABEL
object

Label in the edit form (detailed description)

LABEL
string

Name of the custom field

SORT
integer

Sorting

MULTIPLE
string

Multiple value. Possible values:

  • Y — multiple
  • N — single

Applicable for types string, double, datetime. For the boolean type, N is always used

MANDATORY
string

Mandatory value. Possible values:

  • Y — mandatory
  • N — optional

SETTINGS
object

Additional settings for the field type (detailed description)

Parameter EDIT_FORM_LABEL

Name
type

Description

de
string

Label in German

en
string

Label in English

Parameter SETTINGS

The fields of the SETTINGS object depend on the USER_TYPE_ID type.

Name
type

Description

DEFAULT_VALUE
string

Default value

ROWS
integer

Number of rows in the input field

Name
type

Description

DEFAULT_VALUE
double

Default value

Name
type

Description

DEFAULT_VALUE

Default value. Described as an object with two parameters:

  1. TYPE string — mode for setting the default value
    • NONE — no default value is set
    • FIXED — uses the value from VALUE
    • NOW — uses the current time
  2. VALUE datetime — value for the FIXED type
DEFAULT_VALUE: {
            TYPE: 'NOW',
            VALUE: ''
        },

Name
type

Description

DEFAULT_VALUE
integer

Default value:

  • 0 — no
  • 1 — yes

DISPLAY
string

Display option for the value:

  • CHECKBOX — checkbox
  • RADIO — radio buttons
  • DROPDOWN — dropdown list

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 outcome",
              "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 outcome",
              "ROWS": 10
            }
          },
          "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/task.item.userfield.add
        
try
        {
            const response = await $b24.callMethod(
                '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 outcome',
                            ROWS: 10
                        }
                    }
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.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 outcome',
                                '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 outcome',
                        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 outcome',
                        '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
type

Description

result
integer

Identifier of the created custom field

time
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
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

Status

Code

Description

Value

400

ERROR_CORE

The 'USER_TYPE_ID' field is not found

The USER_TYPE_ID parameter is missing or has an empty value

400

ERROR_CORE

Invalid user type specified.

An invalid or non-existent user field type is specified in the USER_TYPE_ID parameter

400

ERROR_CORE

The 'FIELD_NAME' field is not found

The FIELD_NAME parameter is missing or has an empty value

400

ERROR_CORE

The field UF_TASK_CLIENT_REQUEST for the object TASKS_TASK already exists.

The FIELD_NAME parameter specifies a custom field name that already exists in the system

400

ERROR_CORE

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
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 permitted for calls 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 HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only

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 "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

Previous
Overview of Methods
Next
Update Custom Field