метод REST scope: task

task.item.userfield.add

Добавить пользовательское поле

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

Описание

Метод 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 необязательный

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

Примеры запроса

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

Ответ

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."
}
Код Описание Значение
400 ERROR_CORE The 'USER_TYPE_ID' field is not found
400 ERROR_CORE Указан неверный пользовательский тип.
400 ERROR_CORE The 'FIELD_NAME' field is not found
400 ERROR_CORE Поле UF_TASK_CLIENT_REQUEST для объекта TASKS_TASK уже существует.
400 ERROR_CORE Access denied

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.