Change settings for user field type userfieldtype.update

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: placement

Who can execute the method: administrator

The userfieldtype.update method modifies the settings of a user field type previously registered by the application. It updates the handler URL, name, description, and field height, but does not change the type code.

A field of this type is displayed in the CRM item form. When a user opens the form, Bitrix24 loads the URL from HANDLER in a frame within the field. The general workflow and handler data format are described in User Field Types.

The method returns true if the settings are updated.

The method works only in the application context.

Method parameters

Required parameters are marked with *

Name
type

Description

Restrictions

USER_TYPE_ID*
string

Short code of the previously registered user field type. Retrieve the code using userfieldtype.list

HANDLER
string

New handler URL for the user field type. Bitrix24 loads this URL in a frame within the field

Absolute URLs with the http or https protocol are allowed

TITLE
string

Text name of the type. Will be displayed in the administrative interface for user field settings

DESCRIPTION
string

Text description of the type. Will be displayed in the administrative interface for user field settings

OPTIONS
object

Additional settings. Currently, one key is available: height—specifies the height of the user field in pixels. The value is converted to an integer.
Default is 0. If 0 is specified, the standard height for displaying this widget will be used

LANG_ALL
object

Type name and description for different languages. The object key is the language code, and the value is an object with the TITLE and DESCRIPTION fields

In addition to USER_TYPE_ID, pass at least one parameter with new settings: HANDLER, TITLE, DESCRIPTION, OPTIONS, or LANG_ALL.

Code examples

How to Use Examples in Documentation

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
        
// 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.update',
            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('userfieldtype.update 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 updateUserFieldType() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'userfieldtype.update',
                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('userfieldtype.update result:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateUserFieldType)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        options = {
            "height": 60,
        }
        
        try:
            bitrix_response = client.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=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 {
            $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' => 'Updated 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.update", 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.update: %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)
        

Response handling

HTTP status: 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
            }
        }
        

Returned data

Name
type

Description

result
boolean

Result of changing the user field type

time
time

Information about the execution time of the request

Error handling

HTTP status: 400 or 403

{
            "error":"ERROR_NOT_FOUND",
            "error_description":"User Field Type not found"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible error codes

Code

Error message

Description

ERROR_CORE

Unable to update User Field Type: Handler already binded

HANDLER is already occupied by another user field type of this application

ERROR_ARGUMENT

Argument 'USER_TYPE_ID' is null or empty

USER_TYPE_ID is not specified

ERROR_ARGUMENT

Argument 'HANDLER|TITLE|DESCRIPTION' is null or empty

No settings to update were passed: HANDLER, TITLE, DESCRIPTION, OPTIONS, or LANG_ALL

ERROR_NOT_FOUND

User Field Type not found

No registered user field type with the specified USER_TYPE_ID was found

ERROR_UNSUPPORTED_PROTOCOL

Unsupported handler protocol

HANDLER uses a protocol other than http or https

ERROR_WRONG_HANDLER_URL

Wrong handler URL

HANDLER contains an invalid absolute URL

WRONG_AUTH_TYPE

Current authorization type is denied for this method

The method was called outside the application context

ACCESS_DENIED

Access denied!

The method was called by a user without administrator permissions

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Exploring