Добавить пользовательское поле task.item.userfield.add

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: task

Кто может выполнять метод: администратор

Метод task.item.userfield.add создает пользовательское поле задачи.

При создании пользовательского поля обязательно использовать префикс UF_ в названии поля FIELD_NAME. Если не указать префикс, система автоматически добавит его в начало названия.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

PARAMS*
object

Набор параметров создаваемого поля (подробное описание)

Параметр PARAMS

Название
тип

Описание

USER_TYPE_ID*
string

Тип данных пользовательского поля.

Поддерживаются значения:

  • string — строка
  • double — число
  • datetime — дата и время
  • boolean — да/нет

FIELD_NAME*
string

Код пользовательского поля

XML_ID
string

Внешний идентификатор

EDIT_FORM_LABEL
object

Подпись в форме редактирования (подробное описание)

LABEL
string

Название пользовательского поля

SORT
integer

Сортировка

MULTIPLE
string

Множественное значение. Возможные значения:

  • Y — множественное
  • N — единственное

Применяется для типов string, double, datetime. Для типа boolean всегда используется N

MANDATORY
string

Обязательное значение. Возможные значения:

  • Y — обязательно
  • N — не обязательное

SETTINGS
object

Дополнительные настройки типа поля (подробное описание)

Параметр EDIT_FORM_LABEL

Название
тип

Описание

ru
string

Подпись на русском языке

en
string

Подпись на английском языке

Параметр SETTINGS

Поля объекта SETTINGS зависят от типа USER_TYPE_ID.

Название
тип

Описание

DEFAULT_VALUE
string

Значение по умолчанию

ROWS
integer

Количество строк в поле ввода

Название
тип

Описание

DEFAULT_VALUE
double

Значение по умолчанию

Название
тип

Описание

DEFAULT_VALUE

Значение по умолчанию. Описывается как объект с двумя параметрами:

  1. TYPE string — режим заполнения значения по умолчанию
    • NONE — значение по умолчанию не задается
    • FIXED — используется значение из VALUE
    • NOW — используется текущее время
  2. VALUE datetime — значение для типа FIXED
DEFAULT_VALUE: {
            TYPE: 'NOW',
            VALUE: ''
        },
        

Название
тип

Описание

DEFAULT_VALUE
integer

Значение по умолчанию:

  • 0 — нет
  • 1 — да

DISPLAY
string

Вариант отображения значения:

  • CHECKBOX — флажок
  • RADIO — радиокнопки
  • DROPDOWN — выпадающий список

Примеры кода

Как использовать примеры в документации

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": {
              "ru": "Запрос клиента",
              "en": "Client request"
            },
            "LABEL": "Запрос клиента",
            "SORT": 220,
            "MULTIPLE": "N",
            "MANDATORY": "Y",
            "SETTINGS": {
              "DEFAULT_VALUE": "Уточнить цель и ожидаемый результат",
              "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": {
              "ru": "Запрос клиента",
              "en": "Client request"
            },
            "LABEL": "Запрос клиента",
            "SORT": 220,
            "MULTIPLE": "N",
            "MANDATORY": "Y",
            "SETTINGS": {
              "DEFAULT_VALUE": "Уточнить цель и ожидаемый результат",
              "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: {
                  ru: 'Запрос клиента',
                  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: {
                      ru: 'Запрос клиента',
                      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' => [
                                'ru' => 'Запрос клиента',
                                'en' => 'Client request'
                            ],
                            'LABEL' => 'Запрос клиента',
                            'SORT' => 220,
                            'MULTIPLE' => 'N',
                            'MANDATORY' => 'Y',
                            'SETTINGS' => [
                                'DEFAULT_VALUE' => 'Уточнить цель и ожидаемый результат',
                                '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: 'Запрос клиента',
                    EDIT_FORM_LABEL: {
                        ru: 'Запрос клиента',
                        en: 'Client request'
                    },
                    SORT: 220,
                    MULTIPLE: 'N',
                    MANDATORY: 'Y',
                    SETTINGS: {
                        DEFAULT_VALUE: 'Уточнить цель и ожидаемый результат',
                        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' => [
                        'ru' => 'Запрос клиента',
                        'en' => 'Client request'
                    ],
                    'LABEL' => 'Запрос клиента',
                    'SORT' => 220,
                    'MULTIPLE' => 'N',
                    'MANDATORY' => 'Y',
                    'SETTINGS' => [
                        'DEFAULT_VALUE' => 'Уточнить цель и ожидаемый результат',
                        'ROWS' => 10
                    ]
                ]
            ]
        );
        
        print_r($result);
        

Обработка ответа

HTTP-статус: 200

{
            "result": 1325,
            "time": {
                "start": 1772711476,
                "finish": 1772711476.284127,
                "duration": 0.28412699699401855,
                "processing": 0,
                "date_start": "2026-03-05T14:51:16+03:00",
                "date_finish": "2026-03-05T14:51:16+03:00",
                "operating_reset_at": 1772712076,
                "operating": 0
            }
        }
        

Возвращаемые данные

Название
тип

Описание

result
integer

Идентификатор созданного пользовательского поля

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
            "error": "ERROR_CORE",
            "error_description": "The 'USER_TYPE_ID' field is not found."
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Статус

Код

Описание

Значение

400

ERROR_CORE

The 'USER_TYPE_ID' field is not found

Не передан параметр USER_TYPE_ID или передано пустое значение

400

ERROR_CORE

Указан неверный пользовательский тип.

В параметре USER_TYPE_ID указан неверный или несуществующий тип пользовательского поля

400

ERROR_CORE

The 'FIELD_NAME' field is not found

Не передан параметр FIELD_NAME или передано пустое значение

400

ERROR_CORE

Поле UF_TASK_CLIENT_REQUEST для объекта TASKS_TASK уже существует.

В параметре FIELD_NAME указано название пользовательского поля, которое уже есть в системе

400

ERROR_CORE

Access denied

Недостаточно прав для создания пользовательского поля

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение