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

Scope: crm

Who can execute the method: CRM administrator

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 set of available settings, which are described below. The field only overwrites the passed values
LIST `uf_enum_element[]`	List of possible values for the custom field of type `enumeration`, description below
SORT `integer`	Sort index. Must be greater than zero
SHOW_IN_LIST `boolean`	Should the custom field be shown in the list? This parameter has no effect within `crm`. Possible values: `Y` — yes `N` — no
EDIT_IN_LIST `boolean`	Allow user editing? Possible values: `Y` — yes `N` — no Value `N` is not supported by all field types within `crm`
IS_SEARCHABLE `boolean`	Are the field values searchable? This parameter has no effect within `crm`. Possible values: `Y` — yes `N` — no
LIST_FILTER_LABEL `string`\|`lang_map`	Filter label in the list. When passing a string, it is set for each language. For languages without an explicitly specified value, `''` will be recorded. The field completely overwrites the previous value
LIST_COLUMN_LABEL `string`\|`lang_map`	Header in the list. When passing a string, it is set for each language. For languages without an explicitly specified value, `''` will be recorded. The field completely overwrites the previous value
EDIT_FORM_LABEL `string`\|`lang_map`	Label in the edit form. When passing a string, it is set for each language. For languages without an explicitly specified value, `''` 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 — yes, 0 — 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.
Object format:

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

where:

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

Name
type

Description

DISPLAY
string

Appearance. Possible values:

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

LIST_HEIGHT

Height of the list. Must be greater than 0.

Available only when DISPLAY = LIST or DISPLAY = UI

Name `type`	Description
IBLOCK_TYPE_ID `string`	Identifier of the information block type
IBLOCK_ID `string`	Identifier of the information block
DEFAULT_VALUE `string`	Default value
DISPLAY `string`	Appearance. Possible values: `DIALOG` — dialog `UI` — input list `LIST` — list `CHECKBOX` — checkboxes
LIST_HEIGHT `integer`	Height of the list. Must be greater than 0
ACTIVE_FILTER `boolean`	Should elements with the active flag be shown? Possible values: `Y` — yes `N` — no

Name
type

Description

ENTITY_TYPE
string

Identifier of the reference type.

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

Name `type`	Description
LEAD `boolean`	Is the binding to Leads enabled? Possible values: `Y` — yes `N` — no
CONTACT `boolean`	Is the binding to Contacts enabled? Possible values: `Y` — yes `N` — no
COMPANY `boolean`	Is the binding to Companies enabled? Possible values: `Y` — yes `N` — no
DEAL `boolean`	Is the binding to Deals 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 custom field list

Code Examples

How to Use Examples in Documentation

Example of Updating a String Type Custom Field

cURL (Webhook)

cURL (OAuth)

PHP

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)","de":"Hallo, Welt! Spalte (geändert)"},"EDIT_FORM_LABEL":{"en":"Hello, World! Edit (changed)","de":"Hallo, Welt! Bearbeiten (geändert)"},"ERROR_MESSAGE":{"en":"Hello, World! Error (changed)","de":"Hallo, Welt! Fehler (geändert)"},"HELP_MESSAGE":{"en":"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)","de":"Hallo, Welt! Spalte (geändert)"},"EDIT_FORM_LABEL":{"en":"Hello, World! Edit (changed)","de":"Hallo, Welt! Bearbeiten (geändert)"},"ERROR_MESSAGE":{"en":"Hello, World! Error (changed)","de":"Hallo, Welt! Fehler (geändert)"},"HELP_MESSAGE":{"en":"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)",
                        "de": "Hallo, Welt! Spalte (geändert)"
                    },
                    EDIT_FORM_LABEL: {
                        "en": "Hello, World! Edit (changed)",
                        "de": "Hallo, Welt! Bearbeiten (geändert)"
                    },
                    ERROR_MESSAGE: {
                        "en": "Hello, World! Error (changed)",
                        "de": "Hallo, Welt! Fehler (geändert)"
                    },
                    HELP_MESSAGE: {
                        "en": "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)",
                        'de' => "Hallo, Welt! Spalte (geändert)"
                    ],
                    'EDIT_FORM_LABEL' => [
                        'en' => "Hello, World! Edit (changed)",
                        'de' => "Hallo, Welt! Bearbeiten (geändert)"
                    ],
                    'ERROR_MESSAGE' => [
                        'en' => "Hello, World! Error (changed)",
                        'de' => "Hallo, Welt! Fehler (geändert)"
                    ],
                    'HELP_MESSAGE' => [
                        'en' => "Hello, World! Help (changed)",
                        'de' => "Hallo, Welt! Hilfe (geändert)"
                    ],
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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+02:00",
                "date_finish": "2025-07-29T14:57:14+02: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 may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
`400`	`Parameter 'fields' must be array`	The passed `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 custom field with the passed `id` does not exist
`ERROR_CORE`	`List element with value XML_ID='XML_ID' already exists`	The passed `XML_ID` for the list element must be unique within the elements of the custom field

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

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

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