Update Existing Custom Field for Deals crm.deal.userfield.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: crm

Who can execute the method: administrator CRM

The method crm.deal.userfield.update updates an existing custom field for deals.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Identifier of the custom field.

The identifier can be obtained using the methods crm.deal.userfield.add and crm.deal.userfield.list

fields*
object

Object format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }

field_n — field name
value_n — new field value

The list of available fields is described below.

An incorrect field in fields will be ignored.

Only those fields that need to be changed should be passed in fields

Parameter fields

Required parameters are marked with *

Parameter `type`	Description
MANDATORY `boolean`	Is the field mandatory? Possible values: `Y` — yes `N` — no
SHOW_FILTER `boolean`	Should the field be shown in the filter? Possible values: `Y` — yes `N` — no
XML_ID `string`	External code
SETTINGS `object`	Additional field parameters. Each field type `USER_TYPE_ID` has its own pool of available settings, which are described below. The field only overwrites the passed values
LIST `uf_enum_element[]`	List of possible values for the user field of type `enumeration`, description below
SORT `integer`	Sort index. Must be greater than zero
SHOW_IN_LIST `boolean`	Should the user field be shown in the list? This parameter does not affect anything within `crm`. Possible values: `Y` — yes `N` — no
EDIT_IN_LIST `boolean`	Allow user editing? Possible values: `Y` — yes `N` — no The value `N` is not supported by all field types within `crm`
IS_SEARCHABLE `boolean`	Are the field values searchable? This parameter does not affect anything within `crm`. Possible values: `Y` — yes `N` — no
LIST_FILTER_LABEL `string`\|`lang_map`	Filter label in the list. When a string is passed, it is set for each language. For languages where no value is explicitly specified, `''` will be recorded. The field completely overwrites the previous value
LIST_COLUMN_LABEL `string`\|`lang_map`	Header in the list. When a string is passed, it is set for each language. For languages where no value is explicitly specified, `''` will be recorded. The field completely overwrites the previous value
EDIT_FORM_LABEL `string`\|`lang_map`	Label in the edit form. When a string is passed, it is set for each language. For languages where no value is explicitly specified, `''` will be recorded. The field completely overwrites the previous value
ERROR_MESSAGE `string`\|`lang_map`	Error message
HELP_MESSAGE `string`\|`lang_map`	Help

Parameter SETTINGS

Each type of custom field has its own set of additional settings. This method only supports those described below.

string

integer

double

boolean

date|datetime

enumeration

iblock_section|iblock_element

crm_status

crm

Name `type`	Description
DEFAULT_VALUE `string`	Default value
ROWS `integer`	Number of rows in the input field. Must be greater than 0

Name `type`	Description
DEFAULT_VALUE `integer`	Default value

Name `type`	Description
DEFAULT_VALUE `double`	Default value
PRECISION `integer`	Number precision. Must be greater than or equal to 0

Name
type

Description

DEFAULT_VALUE
integer

Default value, where 1 is yes, 0 is no.

Possible values:

>= 1 -> 1
<= 0 -> 0

DISPLAY
string

Appearance. Possible values:

CHECKBOX — checkbox
RADIO — radio buttons
DROPDOWN — dropdown list

Name
type

Description

DEFAULT_VALUE
object

Default value.
Format object:

{
            VALUE: datetime|date,
            TYPE: 'NONE'|'NOW'|'FIXED',
        }

where:

VALUE — default value of type datetime or date
TYPE — default value type:
- NONE — do not set default value
- NOW — use current time/date
- FIXED — use time/date from VALUE

Name
type

Description

DISPLAY
string

Appearance. Possible values:

LIST — list
UI — searchable list
CHECKBOX — checkboxes
DIALOG — entity selection dialog

LIST_HEIGHT

List height. Must be greater than 0.

Available only with DISPLAY = LIST or DISPLAY = UI

Name `type`	Description
IBLOCK_TYPE_ID `string`	Information block type identifier
IBLOCK_ID `string`	Information block identifier
DEFAULT_VALUE `string`	Default value
DISPLAY `string`	Appearance. Possible values: `DIALOG` — dialog `UI` — searchable list `LIST` — list `CHECKBOX` — checkboxes
LIST_HEIGHT `integer`	List height. Must be greater than 0
ACTIVE_FILTER `boolean`	Whether to show items with the activity flag enabled. Possible values: `Y` — yes `N` — no

Name
type

Description

ENTITY_TYPE
string

Dictionary type identifier.

Use crm.status.entity.types to find possible values

Name `type`	Description
LEAD `boolean`	Whether binding to Leads is enabled. Possible values: `Y` — yes `N` — no
CONTACT `boolean`	Whether binding to Contacts is enabled. Possible values: `Y` — yes `N` — no
COMPANY `boolean`	Whether binding to Companies is enabled. Possible values: `Y` — yes `N` — no
DEAL `boolean`	Whether binding to Deals is enabled. Possible values: `Y` — yes `N` — no

Parameter LIST

Name `type`	Description
VALUE `string`	Value of the list element. List elements with an empty or missing `VALUE` will be ignored
SORT `integer`	Sort index. Must be greater than or equal to 0
DEF `boolean`	Is the list element the default value? Possible values: `Y` — yes `N` — no For a multiple field, several `DEF = Y` are allowed. For a non-multiple field, the first passed list element with `DEF = Y` will be considered default
XML_ID `string`	External code of the value. Must be unique within the elements of the user field list

Code Examples

How to Use Examples in Documentation

Example of Updating a String Type Custom Field

cURL (Webhook)

cURL (OAuth)

BX24.js

PHP

Python

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":536,"fields":{"MANDATORY":"N","SHOW_FILTER":"N","SETTINGS":{"DEFAULT_VALUE":"Hello, world! Default value (changed)","ROWS":10},"SORT":2000,"EDIT_IN_LIST":"N","LIST_FILTER_LABEL":"Hello, world! Filter (changed)","LIST_COLUMN_LABEL":{"en":"Hello, World! Column (changed)","ru":"Hello, world! Column (changed)","de":"Hallo, Welt! Spalte (geändert)"},"EDIT_FORM_LABEL":{"en":"Hello, World! Edit (changed)","ru":"Hello, world! Edit (changed)","de":"Hallo, Welt! Bearbeiten (geändert)"},"ERROR_MESSAGE":{"en":"Hello, World! Error (changed)","ru":"Hello, world! Error (changed)","de":"Hallo, Welt! Fehler (geändert)"},"HELP_MESSAGE":{"en":"Hello, World! Help (changed)","ru":"Hello, world! Help (changed)","de":"Hallo, Welt! Hilfe (geändert)"}}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.userfield.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":536,"fields":{"MANDATORY":"N","SHOW_FILTER":"N","SETTINGS":{"DEFAULT_VALUE":"Hello, world! Default value (changed)","ROWS":10},"SORT":2000,"EDIT_IN_LIST":"N","LIST_FILTER_LABEL":"Hello, world! Filter (changed)","LIST_COLUMN_LABEL":{"en":"Hello, World! Column (changed)","ru":"Hello, world! Column (changed)","de":"Hallo, Welt! Spalte (geändert)"},"EDIT_FORM_LABEL":{"en":"Hello, World! Edit (changed)","ru":"Hello, world! Edit (changed)","de":"Hallo, Welt! Bearbeiten (geändert)"},"ERROR_MESSAGE":{"en":"Hello, World! Error (changed)","ru":"Hello, world! Error (changed)","de":"Hallo, Welt! Fehler (geändert)"},"HELP_MESSAGE":{"en":"Hello, World! Help (changed)","ru":"Hello, world! Help (changed)","de":"Hallo, Welt! Hilfe (geändert)"}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.deal.userfield.update

BX24.callMethod(
            'crm.deal.userfield.update',
            {
                id: 536,
                fields: {
                    MANDATORY: "N",
                    SHOW_FILTER: "N",
                    SETTINGS: {
                        DEFAULT_VALUE: "Hello, world! Default value (changed)",
                        ROWS: 10,
                    },
                    SORT: 2000,
                    EDIT_IN_LIST: "N",
                    LIST_FILTER_LABEL: "Hello, world! Filter (changed)",
                    LIST_COLUMN_LABEL: {
                        "en": "Hello, World! Column (changed)",
                        "ru": "Hello, world! Column (changed)",
                        "de": "Hallo, Welt! Spalte (geändert)"
                    },
                    EDIT_FORM_LABEL: {
                        "en": "Hello, World! Edit (changed)",
                        "ru": "Hello, world! Edit (changed)",
                        "de": "Hallo, Welt! Bearbeiten (geändert)"
                    },
                    ERROR_MESSAGE: {
                        "en": "Hello, World! Error (changed)",
                        "ru": "Hello, world! Error (changed)",
                        "de": "Hallo, Welt! Fehler (geändert)"
                    },
                    HELP_MESSAGE: {
                        "en": "Hello, World! Help (changed)",
                        "ru": "Hello, world! Help (changed)",
                        "de": "Hallo, Welt! Hilfe (geändert)"
                    },
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.deal.userfield.update',
            [
                'id' => 536,
                'fields' => [
                    'MANDATORY' => "N",
                    'SHOW_FILTER' => "N",
                    'SETTINGS' => [
                        'DEFAULT_VALUE' => "Hello, world! Default value (changed)",
                        'ROWS' => 10,
                    ],
                    'SORT' => 2000,
                    'EDIT_IN_LIST' => "N",
                    'LIST_FILTER_LABEL' => "Hello, world! Filter (changed)",
                    'LIST_COLUMN_LABEL' => [
                        'en' => "Hello, World! Column (changed)",
                        'ru' => "Hello, world! Column (changed)",
                        'de' => "Hallo, Welt! Spalte (geändert)"
                    ],
                    'EDIT_FORM_LABEL' => [
                        'en' => "Hello, World! Edit (changed)",
                        'ru' => "Hello, world! Edit (changed)",
                        'de' => "Hallo, Welt! Bearbeiten (geändert)"
                    ],
                    'ERROR_MESSAGE' => [
                        'en' => "Hello, World! Error (changed)",
                        'ru' => "Hello, world! Error (changed)",
                        'de' => "Hallo, Welt! Fehler (geändert)"
                    ],
                    'HELP_MESSAGE' => [
                        'en' => "Hello, World! Help (changed)",
                        'ru' => "Hello, world! Help (changed)",
                        'de' => "Hallo, Welt! Hilfe (geändert)"
                    ],
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.deal.userfield.update(
                bitrix_id=536,
                fields={
                    "MANDATORY": "N",
                    "SHOW_FILTER": "N",
                    "SETTINGS": {
                        "DEFAULT_VALUE": "Hello, world! Default value (changed)",
                        "ROWS": 10,
                    },
                    "SORT": 2000,
                    "EDIT_IN_LIST": "N",
                    "LIST_FILTER_LABEL": "Hello, world! Filter (changed)",
                    "LIST_COLUMN_LABEL": {
                        "en": "Hello, World! Column (changed)",
                        "ru": "Hello, world! Column (changed)",
                        "de": "Hallo, Welt! Spalte (geändert)",
                    },
                    "EDIT_FORM_LABEL": {
                        "en": "Hello, World! Edit (changed)",
                        "ru": "Hello, world! Edit (changed)",
                        "de": "Hallo, Welt! Bearbeiten (geändert)",
                    },
                    "ERROR_MESSAGE": {
                        "en": "Hello, World! Error (changed)",
                        "ru": "Hello, world! Error (changed)",
                        "de": "Hallo, Welt! Fehler (geändert)",
                    },
                    "HELP_MESSAGE": {
                        "en": "Hello, World! Help (changed)",
                        "ru": "Hello, world! Help (changed)",
                        "de": "Hallo, Welt! Hilfe (geändert)",
                    },
                },
            ).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}")

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.deal.userfield.update", b24.Params{
        	"id": 536,
        	"fields": b24.Params{
        		"MANDATORY":   "N",
        		"SHOW_FILTER": "N",
        		"SETTINGS": b24.Params{
        			"DEFAULT_VALUE": "Hello, world! Default value (changed)",
        			"ROWS":          10,
        		},
        		"SORT":              2000,
        		"EDIT_IN_LIST":      "N",
        		"LIST_FILTER_LABEL": "Hello, world! Filter (changed)",
        		"LIST_COLUMN_LABEL": b24.Params{
        			"en": "Hello, World! Column (changed)",
        			"de": "Hallo, Welt! Spalte (geändert)",
        		},
        		"EDIT_FORM_LABEL": b24.Params{
        			"en": "Hello, World! Edit (changed)",
        			"de": "Hallo, Welt! Bearbeiten (geändert)",
        		},
        		"ERROR_MESSAGE": b24.Params{
        			"en": "Hello, World! Error (changed)",
        			"de": "Hallo, Welt! Fehler (geändert)",
        		},
        		"HELP_MESSAGE": b24.Params{
        			"en": "Hello, World! Help (changed)",
        			"de": "Hallo, Welt! Hilfe (geändert)",
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.deal.userfield.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": 1753790234.592207,
                "finish": 1753790234.762644,
                "duration": 0.17043709754943848,
                "processing": 0.11566615104675293,
                "date_start": "2025-07-29T14:57:14+03:00",
                "date_finish": "2025-07-29T14:57:14+03:00",
                "operating_reset_at": 1753790834,
                "operating": 0.11564803123474121
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Root element of the response, contains `true` in case of success
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": "",
            "error_description": "Access denied."
        }

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	Description	Value
`400`	`Parameter 'fields' must be array`	The provided `fields` is not an object
`400`	`ID is not defined or invalid`	The passed `id` is less than zero or not passed at all
`403`	`Access denied`	Occurs when: the user does not have administrative rights the user tries to change a custom field not linked to deals
`ERROR_NOT_FOUND`	`The entity with ID 'id' is not found`	The user field with the passed `id` does not exist
`ERROR_CORE`	`List item with XML_ID='XML_ID' already exists`	The passed `XML_ID` for the list element must be unique within the elements of the user field list

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 Learning

Was the article helpful?

Add Custom Field

Get Deal Custom Field by Id

Update Existing Custom Field for Deals crm.deal.userfield.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Parameter SETTINGSParameter SETTINGS

Parameter LISTParameter LIST

Code ExamplesCode Examples

Example of Updating a String Type Custom FieldExample of Updating a String Type Custom Field

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Parameters

Parameter fields

Parameter SETTINGS

Parameter LIST

Code Examples

Example of Updating a String Type Custom Field

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning