# userfieldtype.add

URL: https://chugunov.pro/api-bitrix24/widgets/user-field/userfieldtype-add/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Зарегистрировать новый тип пользовательских полей
Scope: `placement`
Кто может выполнять метод: администратор

## Описание

Метод `userfieldtype.add` регистрирует новый тип пользовательских полей. После регистрации типа, создайте пользовательское поле методом [userfieldconfig.add](https://chugunov.pro/api-bitrix24/crm/universal/userfieldconfig/userfieldconfig-add/).

При открытии карточки с полем пользовательского типа на обработчик приложения передается массив `PLACEMENT_OPTIONS` с данными о поле и элементе.

```json
{
    "MODE": "view",
    "ENTITY_ID": "CRM_DEAL",
    "FIELD_NAME": "UF_CRM_TEST_TYPE_1",
    "ENTITY_VALUE_ID": "7303",
    "VALUE": null,
    "MULTIPLE": "N",
    "MANDATORY": "N",
    "XML_ID": null,
    "ENTITY_DATA": {
        "entityTypeId": 2,
        "entityId": "7303",
        "module": "crm"
    }
}
```

## Параметры

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

## Ответ

HTTP-статус: 200

```json
{
    "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

```json
{
    "error":"ERROR_CORE",
    "error_description":"Unable to set placement handler: Handler already binded"
}
```

- `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_ARGUMENT` — Argument 'HANDLER' is null or empty. Не задан `HANDLER`

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

### cURL (Webhook)

```bash
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.add
```

### cURL (OAuth)

```bash
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.add
```

### JS (TS)

```ts
// 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<boolean>({
    method: 'userfieldtype.add',
    params: {
      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,
      },
    },
    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('Registration result:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- 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 addUserFieldType() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'userfieldtype.add',
        params: {
          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,
          },
        },
        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('Registration result:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addUserFieldType)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

options = {
    "height": 60,
}

try:
    bitrix_response = client.userfieldtype.add(
        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=options,
    ).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}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'userfieldtype.add',
            [
                '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,
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($result->error()) {
        error_log($result->error());
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error adding user field type: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'userfieldtype.add',
    {
        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());
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'userfieldtype.add',
    [
        '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>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "userfieldtype.add", b24.Params{
	"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": b24.Params{
		"height": 60,
	},
})
if err != nil {
	return fmt.Errorf("userfieldtype.add: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/widgets/user-field/userfieldtype-add.html