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
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"
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/task.item.userfield.update
// 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
// Shape of the payload returned in result (match the "response handling" section of the page)
type UpdateUserFieldResult = boolean
try {
const response = await $b24.actions.v2.call.make<UpdateUserFieldResult>({
method: 'task.item.userfield.update',
params: {
ID: 1325,
DATA: {
EDIT_FORM_LABEL: {
ru: 'Описание запроса клиента',
en: 'Description of client request',
},
MANDATORY: 'N',
},
},
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('Field updated successfully:', 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 updateUserField() {
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.update',
params: {
ID: 1325,
DATA: {
EDIT_FORM_LABEL: {
ru: 'Описание запроса клиента',
en: 'Description of client request',
},
MANDATORY: 'N',
},
},
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('Field updated successfully:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateUserField)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
data = {
"EDIT_FORM_LABEL": {
"ru": "Описание запроса клиента",
"en": "Description of client request",
},
"MANDATORY": "N",
}
try:
bitrix_response = client.task.item.userfield.update(
bitrix_id=1325,
data=data,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'task.item.userfield.update',
[
'ID' => 1325,
'DATA' => [
'EDIT_FORM_LABEL' => [
'ru' => 'Описание запроса клиента',
'en' => 'Description of client request'
],
'MANDATORY' => 'N',
]
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'task.item.userfield.update',
{
ID: 1325,
DATA: {
EDIT_FORM_LABEL: {
ru: 'Описание запроса клиента',
en: 'Description of client request'
},
MANDATORY: 'N'
}
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'task.item.userfield.update',
[
'ID' => 1325,
'DATA' => [
'EDIT_FORM_LABEL' => [
'ru' => 'Описание запроса клиента',
'en' => 'Description of client request'
],
'MANDATORY' => 'N',
]
]
);
print_r($result);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "task.item.userfield.update", b24.Params{
"ID": 1325,
"DATA": b24.Params{
"EDIT_FORM_LABEL": b24.Params{
"ru": "Описание запроса клиента",
"en": "Description of client request",
},
"MANDATORY": "N",
},
})
if err != nil {
return fmt.Errorf("task.item.userfield.update: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Ответ
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 |

