userfieldtype.update
Scope: в зависимости от места встройки Права на выполнение: для всех
Изменение настроек зарегистрированного приложением типа пользовательских полей. Метод возвращает true или ошибку с описанием причины.
Параметры
Параметр | Тип | Описание | Ограничения |
---|---|---|---|
USER_TYPE_ID | Строка | Строковой код типа. Обязательный параметр. | a-z0-9 |
HANDLER | URL | Адрес обработчика пользовательского типа. Обязательный параметр. | Должен быть в том же домене, что и основной адрес приложения. |
TITLE | Строка | Текстовое название типа. Будет выводиться в административном интерфейсе настройки пользовательских полей. Обязательный параметр. | |
DESCRIPTION | Строка | Текстовое описание типа. Будет выводиться в административном интерфейсе настройки пользовательских полей. |
Примеры
Пример вызова
BX24.callMethod( 'userfieldtype.update', { USER_TYPE_ID: 'test', TITLE: 'Updated test type', DESCRIPTION: 'Test userfield type for documentation with updated description' } );
Пример запроса
POST https://sometestportal.bitrix24.com/rest/userfieldtype.update HTTP/1.1 USER_TYPE_ID=test&TITLE=Updated+test+type&DESCRIPTION=Test+userfield+type+for+documentation+with+updated+description&auth=63t6r4z9cugaciaxocrh2r47zlodp12y HTTP/1.1 200 OK { "result": true }
© «Битрикс», 2001-2024, «1С-Битрикс», 2024