Edit an Existing Contact Custom Field crm.contact.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: CRM administrator

The crm.contact.userfield.update method updates an existing contact custom 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 the custom field of type `enumeration`. For custom fields of other types, this parameter is meaningless
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
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. 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 custom field type has its own set of additional configurations. 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, the value 1 will be set.

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

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, the value 2 will be set

Name
type

Description

DEFAULT_VALUE
integer

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

When a value is passed, the value 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 — default value type:
- NONE — do not set a default value
- NOW — use current time/date
- FIXED — use time/date from VALUE

If an invalid value is passed, the following will be set:

    VALUE: '',
            TYPE: 'NONE',

Name
type

Description

DISPLAY
string

Appearance. Possible values:

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

LIST_HEIGHT

List height. Must be greater than 0

Name `type`	Description
IBLOCK_TYPE_ID `string`	Infoblock type identifier
IBLOCK_ID `string`	Infoblock identifier
DEFAULT_VALUE `string`	Default value
DISPLAY `string`	Appearance. Possible values: `DIALOG` — dialog `UI` — autocomplete 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

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

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

uf_enum_element Type

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

PHP CRest

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

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

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)",
                        '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.contact.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.contact.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.contact.userfield.update: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it
        // into a struct matching the response shape shown below on this page.
        fmt.Printf("%s\n", res.Result)

Example of Modifying 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"
            }
        ]

Modify it as follows:

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

cURL (Webhook)

cURL (OAuth)

BX24.js

PHP CRest

Python

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


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.contact.userfield.update(
                bitrix_id=536,
                fields={
                    "MANDATORY": "N",
                    "SHOW_FILTER": "Y",
                    "SETTINGS": {
                        "DISPLAY": "DIALOG",
                        "LIST_HEIGHT": 3,
                    },
                    "SORT": 1000,
                },
                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,
                    },
                ],
            ).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.contact.userfield.update", b24.Params{
        	"fields": b24.Params{
        		"MANDATORY":   "N",
        		"SHOW_FILTER": "Y",
        		"LIST": []b24.Params{
        			{
        				"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": b24.Params{
        			"DISPLAY":     "DIALOG",
        			"LIST_HEIGHT": 3,
        		},
        		"SORT": 1000,
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.contact.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": 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 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
Empty value	`Parameter 'fields' must be array`	The provided `fields` is not an object
Empty value	`ID is not defined or invalid`	The passed `id` is less than zero or not passed at all
Empty value	`Access denied`	Occurs when: the user does not have administrative rights the user attempts to delete a custom field not associated with contacts
`ERROR_NOT_FOUND`	`The entity with ID 'id' is not found`	The user field with the passed `id` does not exist
`ERROR_CORE`	A 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?

Create a Custom Field for Contacts

Retrieve a Custom Field for Contacts by Id

Edit an Existing Contact Custom Field crm.contact.userfield.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Parameter SETTINGSParameter SETTINGS

uf_enum_element Typeuf_enum_element Type

Code ExamplesCode Examples

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

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

Was the article helpful?

Method Parameters

Parameter fields

Parameter SETTINGS

uf_enum_element Type

Code Examples

Example of Updating a String Type Custom Field

Example of Modifying a List Type Custom Field

Response Handling

Returned Data

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning