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

Applies to types string, double, datetime. For type boolean, 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 filling the default value
    • NONE — default value is not set
    • FIXED — uses the value from VALUE
    • NOW — uses the current time
  2. VALUE datetime — value for type FIXED
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 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
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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

400

ERROR_CORE

The 'USER_TYPE_ID' field is not found

The parameter USER_TYPE_ID is not provided or is empty

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 parameter FIELD_NAME is not provided or is empty

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: 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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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