Add Requisite crm.requisite.add

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: a user with "add" access permission for the contact or company that owns the requisite

This method adds a new requisite.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Set of fields — an object of the form `{"field": "value"[, ...]}` for adding the requisite

Parameter fields

Required parameters are marked with *

Name `type`	Description
ENTITY_TYPE_ID* `integer`	Identifier of the parent entity type. Currently, this can only be: `3` — contact `4` — company Identifiers for all CRM object types can be retrieved using the method crm.enum.ownertype
ENTITY_ID* `integer`	Identifier of the parent entity (contact or company). The identifier can be obtained using the method crm.company.list for a company and the method crm.contact.list for a contact
PRESET_ID* `integer`	Identifier of the requisite template. Template identifiers can be obtained using the method crm.requisite.preset.list
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 database. The purpose of the field may change by the final developer
ORIGINATOR_ID `string`	Identifier of the external information database. 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 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 requisites of the entity 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`	Patronymic
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`	TIN (INN)
RQ_KPP `string`	KPP
RQ_USRLE `string`	Handelsregisternummer (for country DE)
RQ_IFNS `string`	IFNS
RQ_OGRN `string`	OGRN
RQ_OGRNIP `string`	OGRNIP
RQ_OKPO `string`	OKPO
RQ_OKTMO `string`	OKTMO
RQ_OKVED `string`	OKVED
RQ_EDRPOU `string`	EDRPOU (EDRPOU)
RQ_DRFO `string`	DRFO
RQ_KBE `string`	KBE
RQ_IIN `string`	IIN
RQ_BIN `string`	BIN
RQ_ST_CERT_SER `string`	Series of State Registration Certificate
RQ_ST_CERT_NUM `string`	Number of 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 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

Which fields with the prefix RQ_ can be specified?

When creating a requisite, only those fields with the prefix RQ_ that are present in the requisite template linked to the created requisite (see the field PRESET_ID) should be specified. The values of other fields will be saved but will not be visible to the user.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"ENTITY_TYPE_ID":4,"ENTITY_ID":1,"PRESET_ID":1,"NAME":"Organization","ACTIVE":"Y","ADDRESS_ONLY":"N","SORT":500,"RQ_COMPANY_NAME":"Ltd. \"QuickBooks and other similar platforms\"","RQ_COMPANY_FULL_NAME":"LIMITED LIABILITY COMPANY \"QuickBooks and other similar platforms\"","RQ_COMPANY_REG_DATE":"06.04.2007","RQ_DIRECTOR":"SMITH JOHN","RQ_INN":"1717586110","RQ_KPP":"770501001","RQ_OGRN":"5077746476209","UF_CRM_1707997209":"56","UF_CRM_1708012333":"Category 1","XML_ID":"5e4641fd-1dd9-11e6-b2f2-005056c00008"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"ENTITY_TYPE_ID":4,"ENTITY_ID":1,"PRESET_ID":1,"NAME":"Organization","ACTIVE":"Y","ADDRESS_ONLY":"N","SORT":500,"RQ_COMPANY_NAME":"Ltd. \"QuickBooks and other similar platforms\"","RQ_COMPANY_FULL_NAME":"LIMITED LIABILITY COMPANY \"QuickBooks and other similar platforms\"","RQ_COMPANY_REG_DATE":"06.04.2007","RQ_DIRECTOR":"SMITH JOHN","RQ_INN":"1717586110","RQ_KPP":"770501001","RQ_OGRN":"5077746476209","UF_CRM_1707997209":"56","UF_CRM_1708012333":"Category 1","XML_ID":"5e4641fd-1dd9-11e6-b2f2-005056c00008","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.add

// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        try {
          const response = await $b24.actions.v2.call.make<number>({
            method: 'crm.requisite.add',
            params: {
              fields: {
                ENTITY_TYPE_ID: 4,
                ENTITY_ID: 1,
                PRESET_ID: 1,
                NAME: 'Organization',
                ACTIVE: 'Y',
                ADDRESS_ONLY: 'N',
                SORT: 500,
                RQ_COMPANY_NAME: 'Ltd. \"QuickBooks and other similar platforms\"',
                RQ_COMPANY_FULL_NAME: 'LIMITED LIABILITY COMPANY \"QuickBooks and other similar platforms\"',
                RQ_COMPANY_REG_DATE: '06.04.2007',
                RQ_DIRECTOR: 'SMITH JOHN',
                RQ_INN: '1717586110',
                RQ_KPP: '770501001',
                RQ_OGRN: '5077746476209',
                UF_CRM_1707997209: '56',
                UF_CRM_1708012333: 'Category 1',
                XML_ID: '5e4641fd-1dd9-11e6-b2f2-005056c00008',
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Created requisite with ID:', result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function addRequisite() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'crm.requisite.add',
                params: {
                  fields: {
                    ENTITY_TYPE_ID: 4,
                    ENTITY_ID: 1,
                    PRESET_ID: 1,
                    NAME: 'Organization',
                    ACTIVE: 'Y',
                    ADDRESS_ONLY: 'N',
                    SORT: 500,
                    RQ_COMPANY_NAME: 'Ltd. \"QuickBooks and other similar platforms\"',
                    RQ_COMPANY_FULL_NAME: 'LIMITED LIABILITY COMPANY \"QuickBooks and other similar platforms\"',
                    RQ_COMPANY_REG_DATE: '06.04.2007',
                    RQ_DIRECTOR: 'SMITH JOHN',
                    RQ_INN: '1717586110',
                    RQ_KPP: '770501001',
                    RQ_OGRN: '5077746476209',
                    UF_CRM_1707997209: '56',
                    UF_CRM_1708012333: 'Category 1',
                    XML_ID: '5e4641fd-1dd9-11e6-b2f2-005056c00008',
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Created requisite with ID:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addRequisite)
        </script>


        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.requisite.add(
                fields={
                    "ENTITY_TYPE_ID": 4,
                    "ENTITY_ID": 1,
                    "PRESET_ID": 1,
                    "NAME": "Organization",
                    "ACTIVE": "Y",
                    "ADDRESS_ONLY": "N",
                    "SORT": 500,
                    "RQ_COMPANY_NAME": "Ltd. \"QuickBooks and other similar platforms\"",
                    "RQ_COMPANY_FULL_NAME": "LIMITED LIABILITY COMPANY \"QuickBooks and other similar platforms\"",
                    "RQ_COMPANY_REG_DATE": "06.04.2007",
                    "RQ_DIRECTOR": "SMITH JOHN",
                    "RQ_INN": "1717586110",
                    "RQ_KPP": "770501001",
                    "RQ_OGRN": "5077746476209",
                    "UF_CRM_1707997209": "56",
                    "UF_CRM_1708012333": "Category 1",
                    "XML_ID": "5e4641fd-1dd9-11e6-b2f2-005056c00008",
                },
            ).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}")

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.add',
                    [
                        'fields' => [
                            'ENTITY_TYPE_ID'        => 4,
                            'ENTITY_ID'             => 1,
                            'PRESET_ID'             => 1,
                            'NAME'                  => 'Organization',
                            'ACTIVE'                => 'Y',
                            'ADDRESS_ONLY'          => 'N',
                            'SORT'                  => 500,
                            'RQ_COMPANY_NAME'       => 'Ltd. \"QuickBooks and other similar platforms\"',
                            'RQ_COMPANY_FULL_NAME'  => 'LIMITED LIABILITY COMPANY \"QuickBooks and other similar platforms\"',
                            'RQ_COMPANY_REG_DATE'   => '06.04.2007',
                            'RQ_DIRECTOR'           => 'SMITH JOHN',
                            'RQ_INN'                => '1717586110',
                            'RQ_KPP'                => '770501001',
                            'RQ_OGRN'               => '5077746476209',
                            'UF_CRM_1707997209'     => '56',
                            'UF_CRM_1708012333'     => 'Category 1',
                            'XML_ID'                => '5e4641fd-1dd9-11e6-b2f2-005056c00008',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Attribute created with ID ' . $result;
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error creating requisite: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.requisite.add",
            {
                fields:
                {
                    "ENTITY_TYPE_ID": 4,
                    "ENTITY_ID": 1,
                    "PRESET_ID": 1,
                    "NAME": "Organization",
                    "ACTIVE": "Y",
                    "ADDRESS_ONLY": "N",
                    "SORT": 500,
                    "RQ_COMPANY_NAME": "Ltd. \"QuickBooks and other similar platforms\"",
                    "RQ_COMPANY_FULL_NAME": "LIMITED LIABILITY COMPANY \"QuickBooks and other similar platforms\"",
                    "RQ_COMPANY_REG_DATE": "06.04.2007",
                    "RQ_DIRECTOR": "SMITH JOHN",
                    "RQ_INN": "1717586110",
                    "RQ_KPP": "770501001",
                    "RQ_OGRN": "5077746476209",
                    "UF_CRM_1707997209": "56",
                    "UF_CRM_1708012333": "Category 1",
                    "XML_ID": "5e4641fd-1dd9-11e6-b2f2-005056c00008"
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.info("Attribute created with ID " + result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.add',
            [
                'fields' => [
                    "ENTITY_TYPE_ID" => 4,
                    "ENTITY_ID" => 1,
                    "PRESET_ID" => 1,
                    "NAME" => "Organization",
                    "ACTIVE" => "Y",
                    "ADDRESS_ONLY" => "N",
                    "SORT" => 500,
                    "RQ_COMPANY_NAME" => "Ltd. \"QuickBooks and other similar platforms\"",
                    "RQ_COMPANY_FULL_NAME" => "LIMITED LIABILITY COMPANY \"QuickBooks and other similar platforms\"",
                    "RQ_COMPANY_REG_DATE" => "06.04.2007",
                    "RQ_DIRECTOR" => "SMITH JOHN",
                    "RQ_INN" => "1717586110",
                    "RQ_KPP" => "770501001",
                    "RQ_OGRN" => "5077746476209",
                    "UF_CRM_1707997209" => "56",
                    "UF_CRM_1708012333" => "Category 1",
                    "XML_ID" => "5e4641fd-1dd9-11e6-b2f2-005056c00008"
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.requisite.add", b24.Params{
        	"fields": b24.Params{
        		"ENTITY_TYPE_ID":       4,
        		"ENTITY_ID":            1,
        		"PRESET_ID":            1,
        		"NAME":                 "Organization",
        		"ACTIVE":               "Y",
        		"ADDRESS_ONLY":         "N",
        		"SORT":                 500,
        		"RQ_COMPANY_NAME":      "Mueller GmbH",
        		"RQ_COMPANY_FULL_NAME": "MUELLER GESELLSCHAFT MIT BESCHRAENKTER HAFTUNG",
        		"RQ_COMPANY_REG_DATE":  "06.04.2007",
        		"RQ_DIRECTOR":          "SMITH JOHN",
        		"RQ_INN":               "7717586110",
        		"RQ_KPP":               "770501001",
        		"RQ_OGRN":              "5077746476209",
        		"UF_CRM_1707997209":    "56",
        		"UF_CRM_1708012333":    "Category 1",
        		"XML_ID":               "5e4641fd-1dd9-11e6-b2f2-005056c00008",
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.requisite.add: %w", err)
        }
        
        var newID b24.ID
        if err := json.Unmarshal(res.Result, &newID); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("id:", newID)

Response Handling

HTTP status: 200

{
            "result": 27,
            "time": {
                "start": 1716998748.040801,
                "finish": 1716998749.444508,
                "duration": 1.4037070274353027,
                "processing": 0.32904696464538574,
                "date_start": "2024-05-29T18:05:48+02:00",
                "date_finish": "2024-05-29T18:05:49+02:00",
                "operating": 0.32897305488586426
            }
        }

Returned Data

Name `type`	Description
result `integer`	Identifier of the created requisite
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": "",
            "error_description": "ENTITY_TYPE_ID is not defined or invalid."
        }

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	Error text	Description
Empty string	ENTITY_TYPE_ID is not defined or invalid.	Identifier of the parent entity type is not defined or has an invalid value
Empty string	ENTITY_ID is not defined or invalid.	Identifier of the parent entity is not defined or has an invalid value
Empty string	PRESET_ID is not defined or invalid.	Identifier of the requisite template is not defined or has an invalid value
Empty string	Entity not found.	The entity for which the requisite is being created was not found
Empty string	Access denied.	Insufficient access permissions to add the requisite

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?

Overview of methods

Update detail

Add Requisite crm.requisite.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

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