Update Existing Custom Contact Field crm.contact.userfield.update

Scope: crm

Who can execute the method: administrator

The method crm.contact.userfield.update updates an existing custom contact field.

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.contact.userfield.add and crm.contact.userfield.list

fields*
object

Object format:

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

where:

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

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 a custom field of type `enumeration`. This parameter is meaningless for custom fields of other types
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
IS_SEARCHABLE `boolean`	Are the field values included in the search? 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 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 passing a string, 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 passing a string, 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. When passing a string, it is set for each language. For languages where no value is explicitly specified, `''` will be recorded. The field completely overwrites the previous value
HELP_MESSAGE `string`\|`lang_map`	Help message. When passing a string, it is set for each language. For languages where no value is explicitly specified, `''` will be recorded. The field completely overwrites the previous value

Parameter SETTINGS

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

string

integer

double

boolean

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 and less than 50.

If a value <= 0 is passed, it will be set to 1.

If a value >= 50 is passed, it will be set to 50

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.

If an invalid value is passed, it will be set to 2

Name
type

Description

DEFAULT_VALUE
integer

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

When passing a value, it will be set according to the rule:

>= 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,
            TYPE: 'NONE'|'NOW'|'FIXED',
        }

where

VALUE — default value of type datetime
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

If an invalid value is passed, it will be set to:

    VALUE: '',
            TYPE: 'NONE',

Name
type

Description

DISPLAY
string

Appearance. Possible values:

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

LIST_HEIGHT

List height. Must be greater than 0

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`	List height. 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 out possible values

If none of the following options are passed, the binding to leads will be enabled by default (LEAD = Y)

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

Type uf_enum_element

Name `type`	Description
ID `string`	Identifier of the list item. When passing this parameter, the corresponding list item will be changed; otherwise, a new list item will be added. The identifier can be obtained using the method `crm.contact.userfield.get`
DEL `boolean`	Flag necessary for deleting a list item. Makes sense only when passing `ID`. Possible values: `Y` — delete `N` — do not delete Default is `N`
VALUE `string`	Value of the list item
SORT `integer`	Sort index. Must be greater than or equal to 0
DEF `boolean`	Is the list item the default value? Possible values: `Y` — yes `N` — no For a multiple field, multiple `DEF = Y` is allowed. For a non-multiple field, the first passed list item with `DEF = Y` will be considered the default value
XML_ID `string`	External code of the value. Must be unique within the list items of the custom field

Code Examples

How to Use Examples in Documentation

Example of Updating a String Type Custom Field

cURL (Webhook)

cURL (OAuth)

PHP

PHP (B24PhpSdk)

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.contact.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.contact.userfield.update

BX24.callMethod(
            'crm.contact.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.contact.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>';

try {
            $contactUserfieldItemId = 123; // Example ID
            $userfieldFieldsToUpdate = [
                'FIELD_NAME' => 'New Field Name',
                'USER_TYPE_ID' => 'string',
                'SORT' => '100',
                'MULTIPLE' => 'N',
                'MANDATORY' => 'N',
                'SHOW_FILTER' => 'Y',
                'SHOW_IN_LIST' => 'Y',
                'EDIT_IN_LIST' => 'Y',
                'IS_SEARCHABLE' => 'Y',
                'EDIT_FORM_LABEL' => 'New Label',
                'LIST_COLUMN_LABEL' => 'Column Label',
                'LIST_FILTER_LABEL' => 'Filter Label',
                'ERROR_MESSAGE' => 'Error Message',
                'HELP_MESSAGE' => 'Help Message',
                'LIST' => '',
                'SETTINGS' => '',
            ];
        
            $result = $serviceBuilder
                ->getCRMScope()
                ->contactUserfield()
                ->update($contactUserfieldItemId, $userfieldFieldsToUpdate);
        
            if ($result->isSuccess()) {
                print($result->getCoreResponse()->getResponseData()->getResult()[0]);
            } else {
                print("Update failed.");
            }
        } catch (Throwable $e) {
            print("Error: " . $e->getMessage());
        }

Example of Updating a List Type Custom Field

Current list items:

[
            {
                "ID": "115",
                "SORT": "100",
                "VALUE": "List item #1",
                "DEF": "Y",
                "XML_ID": "XML_ID_1"
            },
            {
                "ID": "116",
                "SORT": "200",
                "VALUE": "List item #2",
                "DEF": "N",
                "XML_ID": "XML_ID_2"
            },
            {
                "ID": "117",
                "SORT": "300",
                "VALUE": "List item #3",
                "DEF": "N",
                "XML_ID": "XML_ID_3"
            },
            {
                "ID": "118",
                "SORT": "400",
                "VALUE": "List item #4",
                "DEF": "N",
                "XML_ID": "XML_ID_4"
            }
        ]

Change it as follows:

remove list items with ID = 115 and ID = 116
update the list item with ID = 117:
- VALUE: “List item #3” -> “List item #3 (changed)”
- SORT: 300 -> 50
add a new list item “List item #5”

cURL (Webhook)

cURL (OAuth)

PHP

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"MANDATORY":"N","SHOW_FILTER":"Y","LIST":[{"ID":115,"DEL":"Y"},{"ID":116,"DEL":"Y"},{"ID":117,"VALUE":"List item #3 (changed)","SORT":50},{"VALUE":"List item #5","XML_ID":"XML_ID_5","SORT":500}],"SETTINGS":{"DISPLAY":"DIALOG","LIST_HEIGHT":3},"SORT":1000}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.userfield.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"MANDATORY":"N","SHOW_FILTER":"Y","LIST":[{"ID":115,"DEL":"Y"},{"ID":116,"DEL":"Y"},{"ID":117,"VALUE":"List item #3 (changed)","SORT":50},{"VALUE":"List item #5","XML_ID":"XML_ID_5","SORT":500}],"SETTINGS":{"DISPLAY":"DIALOG","LIST_HEIGHT":3},"SORT":1000},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.contact.userfield.update

BX24.callMethod(
            'crm.contact.userfield.update',
            {
                fields: {
                    MANDATORY: "N",
                    SHOW_FILTER: "Y",
                    LIST: [
                        {
                            ID: 115,
                            DEL: "Y"
                        },
                        {
                            ID: 116,
                            DEL: "Y",
                        },
                        {
                            ID: 117,
                            VALUE: "List item #3 (changed)",
                            SORT: 50,
                        },
                        {
                            VALUE: "List item #5",
                            XML_ID: "XML_ID_5",
                            SORT: 500,
                        },
                    ],
                    SETTINGS: {
                        DISPLAY: "DIALOG",
                        LIST_HEIGHT: 3,
                    },
                    SORT: 1000,
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.contact.userfield.update',
            [
                'fields' => [
                    'MANDATORY' => "N",
                    'SHOW_FILTER' => "Y",
                    'LIST' => [
                        [
                            'ID' => 115,
                            'DEL' => "Y"
                        ],
                        [
                            'ID' => 116,
                            'DEL' => "Y",
                        ],
                        [
                            'ID' => 117,
                            'VALUE' => "List item #3 (changed)",
                            'SORT' => 50,
                        ],
                        [
                            'VALUE' => "List item #5",
                            'XML_ID' => "XML_ID_5",
                            'SORT' => 500,
                        ],
                    ],
                    'SETTINGS' => [
                        'DISPLAY' => "DIALOG",
                        'LIST_HEIGHT' => 3,
                    ],
                    'SORT' => 1000,
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1724419843.518672,
                "finish": 1724419844.120328,
                "duration": 0.6016559600830078,
                "processing": 0.1907808780670166,
                "date_start": "2024-08-23T15:30:43+02:00",
                "date_finish": "2024-08-23T15:30:44+02:00",
                "operating": 0
            }
        }

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

Create a Custom Field for Contacts

Retrieve a Custom Field for Contacts by Id

Update Existing Custom Contact Field crm.contact.userfield.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Parameter SETTINGSParameter SETTINGS

Type uf_enum_elementType uf_enum_element

Code ExamplesCode Examples

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

Example of Updating a List Type Custom FieldExample of Updating a List 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

Type uf_enum_element

Code Examples

Example of Updating a String Type Custom Field

Example of Updating a List Type Custom Field

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning