Update Requisite crm.requisite.update

Scope: crm

Who can execute the method: any user

This method updates an existing requisite.

Method Parameters

Required parameters are marked with *

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

Parameter fields

Required parameters are marked with *

Name `type`	Description
NAME* `string`	Name of the requisite
CODE `string`	Symbolic code of the requisite
XML_ID `string`	External key, used for exchange operations. Identifier of the external information base object. The purpose of the field may change by the final developer
ORIGINATOR_ID `string`	Identifier of the external information base. The purpose of the field may change by the final developer
ACTIVE `char`	Activity status. Values `Y` or `N` are used. Currently, the field does not actually affect anything
ADDRESS_ONLY `char`	Status indicator when the requisite is used only for storing the address. Values `Y` or `N` are used. When set to `Y`, the requisites are not displayed in the entity card, but the address is shown
SORT `integer`	Sorting. Order in the list of entity requisites when there are multiple
RQ_NAME `string`	Full name
RQ_FIRST_NAME `string`	First name
RQ_LAST_NAME `string`	Last name
RQ_SECOND_NAME `string`	Middle name
RQ_COMPANY_ID `string`	Identifier of the organization
RQ_COMPANY_NAME `string`	Short name of the organization
RQ_COMPANY_FULL_NAME `string`	Full name of the organization
RQ_COMPANY_REG_DATE `string`	Date of state registration
RQ_DIRECTOR `string`	General director
RQ_ACCOUNTANT `string`	Chief accountant
RQ_CEO_NAME `string`	Full name of the first leader
RQ_CEO_WORK_POS `string`	Position of the first leader
RQ_CONTACT `string`	Contact person
RQ_EMAIL `string`	E-Mail
RQ_PHONE `string`	Phone
RQ_FAX `string`	Fax
RQ_IDENT_TYPE `crm_status`	Method of identification
RQ_IDENT_DOC `string`	Type of document
RQ_IDENT_DOC_SER `string`	Series
RQ_IDENT_DOC_NUM `string`	Number
RQ_IDENT_DOC_PERS_NUM `string`	Personal number
RQ_IDENT_DOC_DATE `string`	Date of issue
RQ_IDENT_DOC_ISSUED_BY `string`	Issued by
RQ_IDENT_DOC_DEP_CODE `string`	Department code
RQ_INN `string`	Taxpayer Identification Number
RQ_KPP `string`	Tax Registration Reason Code
RQ_USRLE `string`	Handelsregisternummer (for country DE)
RQ_IFNS `string`	Tax Authority
RQ_OGRN `string`	Primary State Registration Number
RQ_OGRNIP `string`	Individual Entrepreneur Registration Number
RQ_OKPO `string`	All-Russian Classifier of Enterprises and Organizations
RQ_OKTMO `string`	All-Russian Classifier of Territorial Units
RQ_OKVED `string`	All-Russian Classifier of Economic Activities
RQ_EDRPOU `string`	Unified State Register of Enterprises and Organizations
RQ_DRFO `string`	Tax Registration Number
RQ_KBE `string`	Classification of Business Entities
RQ_IIN `string`	Individual Identification Number
RQ_BIN `string`	Business Identification Number
RQ_ST_CERT_SER `string`	Series of the state registration certificate
RQ_ST_CERT_NUM `string`	Number of the state registration certificate
RQ_ST_CERT_DATE `string`	Date of the state registration certificate
RQ_VAT_PAYER `char`	VAT payer (for country UA). Values `Y` or `N` are used
RQ_VAT_ID `string`	VAT ID (identification number of the VAT payer)
RQ_VAT_CERT_SER `string`	Series of the VAT certificate
RQ_VAT_CERT_NUM `string`	Number of the VAT certificate
RQ_VAT_CERT_DATE `string`	Date of the VAT certificate
RQ_RESIDENCE_COUNTRY `string`	Country of residence
RQ_BASE_DOC `string`	Basis for action
RQ_REGON `string`	REGON (for country PL)
RQ_KRS `string`	KRS (for country PL)
RQ_PESEL `string`	PESEL (for country PL)
RQ_LEGAL_FORM `string`	Legal form (for country FR)
RQ_SIRET `string`	Siret number (for country FR)
RQ_SIREN `string`	Siren number (for country FR)
RQ_CAPITAL `string`	Share capital (for country FR)
RQ_RCS `string`	RCS (for country FR)
RQ_CNPJ `string`	CNPJ (for country BR)
RQ_STATE_REG `string`	State Registration (IE) (for country BR)
RQ_MNPL_REG `string`	Municipal Registration (IM) (for country BR)
RQ_CPF `string`	CPF (for country BR)
UF_CRM_...	Custom fields. For example, `UF_CRM_1694526604`. Requisites can have a set of custom fields with types: `string`, `boolean`, `double`, `datetime`. You can add a custom field to requisites using the method crm.requisite.userfield.add

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":27,"fields":{"RQ_OKPO":"80715150","RQ_OKTMO":"45381000000","UF_CRM_1707997209":"78","UF_CRM_1708012333":"Category 3"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":27,"fields":{"RQ_OKPO":"80715150","RQ_OKTMO":"45381000000","UF_CRM_1707997209":"78","UF_CRM_1708012333":"Category 3"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.update

try
        {
        	const response = await $b24.callMethod(
        		"crm.requisite.update",
        		{
        			id: 27,
        			fields:
        			{
        				"RQ_OKPO": "80715150",
        				"RQ_OKTMO": "45381000000",
        				"UF_CRM_1707997209": "78",
        				"UF_CRM_1708012333": "Category 3"
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.update',
                    [
                        'id' => 27,
                        'fields' => [
                            'RQ_OKPO'         => '80715150',
                            'RQ_OKTMO'        => '45381000000',
                            'UF_CRM_1707997209' => '78',
                            'UF_CRM_1708012333' => 'Category 3',
                        ],
                    ]
                );
        
            $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 requisite: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.requisite.update",
            {
                id: 27,
                fields:
                {
                    "RQ_OKPO": "80715150",
                    "RQ_OKTMO": "45381000000",
                    "UF_CRM_1707997209": "78",
                    "UF_CRM_1708012333": "Category 3"
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.update',
            [
                'id' => 27,
                'fields' => [
                    'RQ_OKPO' => '80715150',
                    'RQ_OKTMO' => '45381000000',
                    'UF_CRM_1707997209' => '78',
                    'UF_CRM_1708012333' => 'Category 3'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response on Success

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1717163055.335685,
                "finish": 1717163055.892722,
                "duration": 0.5570368766784668,
                "processing": 0.17116189002990723,
                "date_start": "2024-05-31T15:44:15+02:00",
                "date_finish": "2024-05-31T15:44:15+02:00",
                "operating": 0.17112517356872559
            }
        }

Returned Data

Name
type

Description

result
boolean

Returns the value:

true — requisite changed
false — requisite not changed

time
time

Information about the request execution time

Response on Error

HTTP status: 400

{
            "error": "",
            "error_description": "The Requisite with ID '57' 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	The Requisite with ID '57' is not found	The requisite with the specified identifier was not found
Empty string	ID is not defined or invalid.	The requisite identifier is not specified or has an invalid value
Empty string	ENTITY_TYPE_ID is not defined or invalid.	The identifier of the parent entity type is not specified or has an invalid value
Empty string	ENTITY_ID is not defined or invalid.	The identifier of the parent entity is not specified or has an invalid value
Empty string	PRESET_ID is not defined or invalid.	The identifier of the requisite template is not specified or has an invalid value
Empty string	Access denied.	Insufficient access permissions to modify the requisite

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 detail

Get detail by id

Update Requisite crm.requisite.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response on SuccessResponse on Success

Returned DataReturned Data

Response on ErrorResponse on Error

Possible ErrorsPossible Errors

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning