метод REST scope: placement

userfieldtype.update

Изменить настройки типа пользовательских полей

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

Описание

Метод userfieldtype.update изменяет настройки типа пользовательских полей, который ранее зарегистрировало приложение. Метод обновляет адрес обработчика, название, описание и высоту поля, но не меняет код типа.

Поле такого типа выводится в карточке элемента CRM. Когда пользователь открывает карточку, Битрикс24 загружает адрес из HANDLER во фрейме внутри поля. Общая схема работы и формат данных обработчика описаны в статье Пользовательские типы полей.

Метод возвращает true, если настройки изменены.

Метод работает только в контексте приложения

Параметры

USER_TYPE_ID string обязательный

Короткий код уже зарегистрированного типа пользовательских полей. Получить код можно методом userfieldtype.list

HANDLER string необязательный

Новый адрес обработчика пользовательского типа. Битрикс24 загружает этот адрес во фрейме внутри поля

TITLE string необязательный

Текстовое название типа. Будет выводиться в административном интерфейсе настройки пользовательских полей

DESCRIPTION string необязательный

Текстовое описание типа. Будет выводиться в административном интерфейсе настройки пользовательских полей

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

Дополнительные настройки. На данный момент доступен один ключ: height — указывает высоту пользовательского поля в пикселях. Значение преобразуется в целое число.
По умолчанию — 0. Если указано 0, то будет использована стандартная высота для отображения этого виджета

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

Название и описание типа для разных языков. Ключ объекта — код языка, значение — объект с полями TITLE и DESCRIPTION

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "USER_TYPE_ID": "test_type",
    "HANDLER": "https://www.myapplication.com/handler/",
    "TITLE": "Updated test type",
    "DESCRIPTION": "Test userfield type for documentation with updated description",
    "OPTIONS": {
        "height": 60
    },
    "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/userfieldtype.update

Ответ

HTTP-статус: 200

{
    "result":true,
    "time":{
        "start":1724421710.397825,
        "finish":1724421711.040353,
        "duration":0.6425280570983887,
        "processing":5.888938903808594e-5,
        "date_start":"2024-08-23T16:01:50+02:00",
        "date_finish":"2024-08-23T16:01:51+02:00",
        "operating":0
    }
}

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

result boolean

Результат изменения типа пользовательских полей

time time

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

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

HTTP-статус: 400

{
    "error":"ERROR_NOT_FOUND",
    "error_description":"User Field Type not found"
}
Код Описание Значение
ERROR_CORE Unable to update User Field Type: Handler already binded HANDLER уже занят другим типом пользовательских полей этого приложения
ERROR_ARGUMENT Argument 'USER_TYPE_ID' is null or empty Не задан USER_TYPE_ID
ERROR_ARGUMENT Argument 'HANDLER|TITLE|DESCRIPTION' is null or empty Не переданы настройки для изменения: HANDLER, TITLE, DESCRIPTION, OPTIONS или LANG_ALL
ERROR_NOT_FOUND User Field Type not found Не найден зарегистрированный тип пользовательских полей с указанным USER_TYPE_ID
ERROR_UNSUPPORTED_PROTOCOL Unsupported handler protocol В HANDLER указан протокол, отличный от http или https
ERROR_WRONG_HANDLER_URL Wrong handler URL В HANDLER указан некорректный абсолютный адрес
WRONG_AUTH_TYPE Current authorization type is denied for this method Метод вызван не в контексте приложения
ACCESS_DENIED Access denied! Метод вызвал пользователь без прав администратора

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

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