Register a New User Field Type userfieldtype.add

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
        

// 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)
        }
        

<!-- 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>
        

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 error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

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.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());
            }
        );
        

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>';
        

// client and ctx are already created — see the Go SDK section
        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("parse response: %w", err)
        }
        fmt.Println("done:", ok)