метод REST scope: task

task.item.userfield.update

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

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

Описание

Метод task.item.userfield.update обновляет параметры пользовательского поля задачи.

Параметры

ID integer обязательный

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

Идентификатор пользовательского поля задачи можно получить при создании поля или методом получения списка полей

DATA object обязательный

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

Параметр DATA

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 '{
  "ID": 1325,
  "DATA": {
    "EDIT_FORM_LABEL": {
      "ru": "Описание запроса клиента",
      "en": "Description of client request"
    },
    "MANDATORY": "N"
  }
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.item.userfield.update

Ответ

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1740000000.000000,
        "finish": 1740000000.100000,
        "duration": 0.100000,
        "processing": 0.080000,
        "date_start": "2025-02-20T10:00:00+03:00",
        "date_finish": "2025-02-20T10:00:00+03:00",
        "operating_reset_at": 1740003600,
        "operating": 0.080000
    }
}

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

result boolean

Возвращает true, если поле успешно обновлено

time time

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

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

HTTP-статус: 400

{
    "error": "ERROR_CORE",
    "error_description": "ID is not defined or invalid."
}
Код Описание Значение
400 ERROR_CORE TASKS_ERROR_EXCEPTION_#0; Invalid arguments for Bitrix\Tasks\Integration\Rest\Task\UserField::update; 0/TE
400 ERROR_CORE ID is not defined or invalid
400 ERROR_NOT_FOUND The entity with ID '{ID}' is not found
400 ERROR_CORE Access denied

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

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