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

Scope: в зависимости от места встройки

Кто может выполнять метод: любой пользователь

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

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание	Ограничения
USER_TYPE_ID* `string`	Строковый код типа	a-z0-9 должен быть уникальным
HANDLER* `URL`	Адрес обработчика пользовательского типа	в том же домене, что и основной адрес приложения уникальным
TITLE* `string`	Текстовое название типа. Будет выводиться в административном интерфейсе настройки пользовательских полей
DESCRIPTION `string`	Текстовое описание типа. Будет выводиться в административном интерфейсе настройки пользовательских полей
OPTIONS `array`	Дополнительные настройки. На данный момент доступен один ключ: `height` — указывает высоту пользовательского поля в пикселях. Применится любое положительное значение. По умолчанию — `0`. Если указано `0`, то будет использована высота стандартная для отображения данной встройки

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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
            }
        }' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/userfieldtype.update

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

try
        {
        	const response = await $b24.callMethod(
        		'userfieldtype.update',
        		{
        			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,
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $result = $serviceBuilder->getPlacementScope()
                ->userFieldType()
                ->update(
                    'custom_user_type',  // userTypeId
                    'https://example.com/handler',  // handlerUrl
                    'Custom User Type',  // title
                    'Description of custom user type'  // description
                );
            if ($result->isSuccess()) {
                print("Update successful.");
            } else {
                print("Update failed.");
            }
        } catch (Throwable $e) {
            print("An error occurred: " . $e->getMessage());
        }

BX24.callMethod(
            'userfieldtype.update',
            {
                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,
                },
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'userfieldtype.update',
            [
                'USER_TYPE_ID' => 'test_type',
                'HANDLER' => 'https://www.myapplication.com/handler/',
                'TITLE' => 'Upd ated test type',
                'DESCRIPTION' => 'Test userfield type for documentation with updated description',
                'OPTIONS' => [
                    'height' => 60
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

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 `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Cообщение об ошибке	Описание
`ERROR_CORE`	Unable to set placement handler: Handler already binded	`HANDLER` уже занят другим типом пользовательских полей этого приложения или `USER_TYPE_ID` уже используется другим приложением
`ERROR_ARGUMENT`	Argument 'USER_TYPE_ID' is null or empty	Не задан `USER_TYPE_ID`
`ERROR_NOT_FOUND`	User Field Type not found	Не найдено пользовательское поле с указанным `USER_TYPE_ID`

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Зарегистрировать новый тип пользовательских полей

Получить список зарегистрированных типов пользовательских полей

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

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

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

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

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение