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
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>
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": "Запрос клиента",
"en": "Client request",
},
"LABEL": "Запрос клиента",
"SORT": 220,
"MULTIPLE": "N",
"MANDATORY": "Y",
"SETTINGS": {
"DEFAULT_VALUE": "Уточнить цель и ожидаемый результат",
"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",
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.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);
// client и ctx уже созданы — см. раздел «SDK для Go»
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{
"ru": "Запрос клиента",
"en": "Client request",
},
"LABEL": "Запрос клиента",
"SORT": 220,
"MULTIPLE": "N",
"MANDATORY": "Y",
"SETTINGS": b24.Params{
"DEFAULT_VALUE": "Уточнить цель и ожидаемый результат",
"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("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)
Ответ
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 |

