Update Custom Field of Requisite crm.requisite.userfield.update

Scope: crm

Who can execute the method: any user

This method updates an existing custom field of a requisite.

Method Parameters

Required parameters are marked with *

Name `type`	Description
id* `integer`	Identifier of the custom field. Can be obtained using the method crm.requisite.userfield.list
fields* `object`	Set of fields — an object of the form `{"field": "value"[, ...]}`, the values of which need to be changed

Parameter fields

Name `type`	Description
XML_ID `string`	External key. Used for data exchange operations. Identifier of the object in the external information base. The purpose of the field may change by the final developer
SORT `integer`	Sorting
MULTIPLE `char`	Multiplicity indicator. Possible values: `Y` — yes `N` — no
MANDATORY `char`	Mandatory indicator. Possible values: `Y` — yes `N` — no
SHOW_FILTER `char`	Show in the list filter. Possible values: `N` — do not show `I` — exact match `E` — mask `S` — substring
SHOW_IN_LIST `char`	Show in the list. Possible values: `Y` — yes `N` — no
EDIT_IN_LIST `char`	Allow user editing. Possible values: `Y` — yes `N` — no
IS_SEARCHABLE `char`	Are the field values included in the search. Possible values: `Y` — yes `N` — no
EDIT_FORM_LABEL `string`	Label in the edit form
LIST_COLUMN_LABEL `string`	Header in the list
LIST_FILTER_LABEL `string`	Filter label in the list
ERROR_MESSAGE `string`	Error message
HELP_MESSAGE `string`	Help
LIST `uf_enum_element`	List elements. For detailed information, see the section Get Field Descriptions for Custom Field Type "Enumeration" (List) crm.userfield.enumeration.fields
SETTINGS `object`	Additional settings (depend on the type). For detailed information, see the section Get the settings field descriptions for the custom field type crm.userfield.settings.fields

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":235,"fields":{"EDIT_FORM_LABEL":"Category","LIST_COLUMN_LABEL":"Category","LIST_FILTER_LABEL":"Category"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.userfield.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":235,"fields":{"EDIT_FORM_LABEL":"Category","LIST_COLUMN_LABEL":"Category","LIST_FILTER_LABEL":"Category"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.userfield.update

try
        {
        	const response = await $b24.callMethod(
        		"crm.requisite.userfield.update",
        		{
        			id: 235,
        			fields:
        			{
        				"EDIT_FORM_LABEL": title,
        				"LIST_COLUMN_LABEL": title,
        				"LIST_FILTER_LABEL": title
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

$title = "Category";
        
        try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.userfield.update',
                    [
                        'id' => 235,
                        'fields' => [
                            'EDIT_FORM_LABEL'   => $title,
                            'LIST_COLUMN_LABEL' => $title,
                            'LIST_FILTER_LABEL' => $title
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating user field: ' . $e->getMessage();
        }

const title = "Category";
        BX24.callMethod(
            "crm.requisite.userfield.update",
            {
                id: 235,
                fields:
                {
                    "EDIT_FORM_LABEL": title,
                    "LIST_COLUMN_LABEL": title,
                    "LIST_FILTER_LABEL": title
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $title = "Category";
        
        $result = CRest::call(
            'crm.requisite.userfield.update',
            [
                'id' => 235,
                'fields' =>
                [
                    'EDIT_FORM_LABEL' => $title,
                    'LIST_COLUMN_LABEL' => $title,
                    'LIST_FILTER_LABEL' => $title
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1717769551.504986,
                "finish": 1717769551.817433,
                "duration": 0.31244707107543945,
                "processing": 0.04784202575683594,
                "date_start": "2024-06-07T16:12:31+02:00",
                "date_finish": "2024-06-07T16:12:31+02:00",
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
boolean

Result of updating the custom field of the requisite:

true — updated
false — not updated

time
time

Information about the execution time of the request

Error Handling

HTTP status: 40x, 50x

{
            "error": "",
            "error_description": "The entity with ID '235' is not found."
        }

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 Errors

Code	Error Text	Description
Empty string	`Operation is not allowed. Entity ID is not defined`	Custom field with the specified identifier not found
Empty string	`The entity with ID '235' is not found`	Custom field with the specified identifier not found
Empty string	`ID is not defined or invalid`	Identifier of the custom field is not specified or has an invalid value
Empty string	`Access denied`	Insufficient access permissions to modify the custom field
`ERROR_CORE`	`Fail to update user field`	Failed to update the custom field
`ERROR_CORE`	`Fail to save enumeration field values`	Failed to save values of the custom list-type field (e.g., when a duplicate external key of one of the values occurred)

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 New Custom Requisite Field

Get a Custom Field by ID

Update Custom Field of Requisite crm.requisite.userfield.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible ErrorsPossible Errors

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning