Add a Requisite v 3.0 crm.[type].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 permission to edit the contact or company to which the requisite is added

This method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.

The crm.<type>.requisite.add method adds a requisite to a contact or company and returns its ID. The owner type is set by the <type> segment of the method name: company or contact.

Method Name for the Object Type

Object type	Method
Company	`crm.company.requisite.add`
Contact	`crm.contact.requisite.add`

Only contacts and companies have requisites. The owner type is set by the company or contact segment of the method name; the method does not find a requisite of a different owner type. My company requisites are available through the crm.company.* methods.

The method name is written in lowercase: crm.company.requisite.add, not crm.Company.Requisite.Add. If the name is written in a different case, the method returns the "Method Not Found" error.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

Object with the requisite fields in the format {"field": "value"}. Parameter description

A requisite has required fields

The fields Parameter

Name `type`	Description
companyId or contactId* `integer`	ID of the company or contact to which the requisite is added. The field name depends on the method: `companyId` in `crm.company.requisite.add`, `contactId` in `crm.contact.requisite.add`. The owner cannot be changed after creation. The ID can be retrieved with the crm.<type>.list method
presetId* `integer`	Requisite template ID. The template defines which fields can be filled in: organization, sole proprietor, person, and others. The set of templates depends on the country, for example, the German templates are "Unternehmen" and "Natürliche Person". Templates and their fields are returned by the crm.<type>.requisite.preset.list method
name* `string`	Requisite name, for example, "Main requisite"
active `boolean`	Whether the requisite is active. Possible values: `true` — active `false` — inactive Default: `true`
sort `integer`	Sort order. Default: `500`
xmlId `string`	External requisite code
originatorId `string`	ID of the external data source
Requisite data fields	For example, `companyTitle`, `inn`, `vatNumber`, `usrle`, `firstName`, `lastName`. Only the fields included in the `presetId` template can be passed: they are listed in the `fields` array of the template with `kind: "requisiteField"`. The fields are described in the requisite methods overview

Addresses and bank details are not passed in fields. Add them after creating the requisite with the crm.<type>.requisite.address.add and crm.<type>.requisite.bankrequisite.add methods.

Pass a non-empty name. Without name, the method does not respond and the request times out; with an empty string, it returns HTTP 500 INTERNAL_SERVER_ERROR. In both cases, the requisite is not created.

Required Fields

Without these fields, the method returns an error and does not create the requisite:

Object type	Required
Company	`companyId`, `presetId`, and a non-empty `name`
Contact	`contactId`, `presetId`, and a non-empty `name`

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ segment to the request URL:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/crm.company.requisite.add

The examples add a company requisite to the company with the ID 3167. The examples use the German "Unternehmen" template. On your Bitrix24, retrieve the template ID with the crm.<type>.requisite.preset.list method. For a contact, replace the method name with crm.contact.requisite.add and companyId with contactId.

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":{"companyId":3167,"presetId":1,"name":"Main requisite","companyTitle":"Müller GmbH","inn":"21/815/08150","vatNumber":"DE123456789","usrle":"HRB 123456"}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.company.requisite.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"companyId":3167,"presetId":1,"name":"Main requisite","companyTitle":"Müller GmbH","inn":"21/815/08150","vatNumber":"DE123456789","usrle":"HRB 123456"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/crm.company.requisite.add

CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make: such a call returns the SDK error JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(ApiVersion.v3).call.

import { ApiVersion, Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type RequisiteAddResult = {
          id: number
        }
        
        try {
          const response = await $b24.getHttpClient(ApiVersion.v3).call<RequisiteAddResult>(
            'crm.company.requisite.add',
            {
              fields: {
                companyId: 3167,
                presetId: 1,
                name: 'Main requisite',
                companyTitle: 'Müller GmbH',
                inn: '21/815/08150',
                vatNumber: 'DE123456789',
                usrle: 'HRB 123456',
              },
            },
            Text.getUuidRfc4122()
          )
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Requisite created:', result.id)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }

CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(B24Js.ApiVersion.v3).call.

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function addRequisite() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
                'crm.company.requisite.add',
                {
                  fields: {
                    companyId: 3167,
                    presetId: 1,
                    name: 'Main requisite',
                    companyTitle: 'Müller GmbH',
                    inn: '21/815/08150',
                    vatNumber: 'DE123456789',
                    usrle: 'HRB 123456',
                  },
                },
                B24Js.Text.getUuidRfc4122()
              )
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Requisite created:', result.id)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addRequisite)
        </script>

b24pysdk has no ready-made wrappers for CRM methods, and the SDK sends to REST 3.0 only the methods from the Config().api_v3_methods list. Add the method to this list and call it via bitrix_token.call_method with prefer_version=3.

from b24pysdk import Config
        from b24pysdk.errors import BitrixSDKException
        from b24pysdk.errors.v3 import BitrixAPIError
        
        method = "crm.company.requisite.add"
        Config().configure(api_v3_methods=Config().api_v3_methods | {method})
        
        try:
            response = bitrix_token.call_method(
                api_method=method,
                params={
                    "fields": {
                        "companyId": 3167,
                        "presetId": 1,
                        "name": "Main requisite",
                        "companyTitle": "Müller GmbH",
                        "inn": "21/815/08150",
                        "vatNumber": "DE123456789",
                        "usrle": "HRB 123456",
                    },
                },
                prefer_version=3,
            )
            result = response["result"]
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"code: {error.code}",
                f"message: {error.error.message}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.company.requisite.add',
                    [
                        'fields' => [
                            'companyId' => 3167,
                            'presetId' => 1,
                            'name' => 'Main requisite',
                            'companyTitle' => 'Müller GmbH',
                            'inn' => '21/815/08150',
                            'vatNumber' => 'DE123456789',
                            'usrle' => 'HRB 123456',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

BX24.callMethod(
            'crm.company.requisite.add',
            {
                fields: {
                    companyId: 3167,
                    presetId: 1,
                    name: 'Main requisite',
                    companyTitle: 'Müller GmbH',
                    inn: '21/815/08150',
                    vatNumber: 'DE123456789',
                    usrle: 'HRB 123456',
                },
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'crm.company.requisite.add',
            [
                'fields' => [
                    'companyId' => 3167,
                    'presetId' => 1,
                    'name' => 'Main requisite',
                    'companyTitle' => 'Müller GmbH',
                    'inn' => '21/815/08150',
                    'vatNumber' => 'DE123456789',
                    'usrle' => 'HRB 123456',
                ],
            ]
        );
        
        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.company.requisite.add", b24.Params{
        	"fields": b24.Params{
        		"companyId":    3167,
        		"presetId":     1,
        		"name":         "Main requisite",
        		"companyTitle": "Müller GmbH",
        		"inn":          "21/815/08150",
        		"vatNumber":    "DE123456789",
        		"usrle":        "HRB 123456",
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.company.requisite.add: %w", err)
        }
        
        var result struct {
        	ID int `json:"id"`
        }
        if err := json.Unmarshal(res.Result, &result); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(result.ID)

Response Handling

HTTP status: 200

{
            "result": {
                "id": 549
            },
            "time": {
                "start": 1793711900,
                "finish": 1793711900.089311,
                "duration": 0.08931088447570801,
                "processing": 0,
                "date_start": "2026-11-03T16:18:20+03:00",
                "date_finish": "2026-11-03T16:18:20+03:00",
                "operating_reset_at": 1793712480,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Object with response data
result.id `integer`	ID of the created requisite. The requisite fields can be retrieved with the crm.<type>.requisite.get method
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object.",
                "validation": [
                    {
                        "message": "This field is not included in the details template.",
                        "field": "firstName"
                    }
                ]
            }
        }

Name `type`	Description
error.code `string`	String error code. Use it to identify the type of exception
error.message `string`	Text description of the error
error.validation `array`	Array with error details. Present only in data validation errors `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Name of the field where the validation error occurred
error.validation[].message `string`	Description of the error related to the specified field

Possible Error Codes

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field	Error description	How to Fix
`fields`	Required field `fields` is missing	Pass the `fields` object
`presetId`	Details template was not found	Pass a template from the crm.<type>.requisite.preset.list method response
`firstName`	This field is not included in the details template	Pass only the fields listed in `fields` of the `presetId` template. The template fields are returned by the crm.<type>.requisite.preset.get method
`inn`	The field value must not exceed `#MAX_LENGTH#` characters	Shorten the value to the specified length
`vatPayer`	This request requires data type `bool` in field `vatPayer`	Pass a value of the type specified in the field description. Boolean fields accept `true` or `false`

Object Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Field	Error description	How to Fix
`companyId`	Required field `companyId` is empty	Pass the owner: `companyId` for a company, `contactId` for a contact
`presetId`	Required field `presetId` is empty	Pass `presetId`
`createdById`	Field `createdById` is read-only	Remove the read-only field from `fields`. The method returns the same error for `id`, `createdTime`, `updatedTime`, `updatedById`, `addresses`, and `bankRequisites`

Owner Not Found

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Field	Error description	How to Fix
`-`	Entity with ID #ID# was not found	The contact or company does not exist, or you have no permission to edit it. Check the owner ID and the method name

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field	Error description	How to Fix
`-`	Unknown field `#FIELD#` found in entity `OwnerRequisiteCompanyDto`	Check the field name against the requisite field description. The owner is `companyId` in company methods and `contactId` in contact methods

Method Not Found

Error Code: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP status: 404

Field	Error description	How to Fix
`-`	Method `#METHOD#` was not found	Check the method name: it is written in lowercase, for example, `crm.company.requisite.add`. Requisite methods exist only for contacts and companies: the `company` or `contact` segment

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 a Requisite

Add a Requisite v 3.0 crm.[type].requisite.add

Method Name for the Object TypeMethod Name for the Object Type

Method ParametersMethod Parameters

The fields ParameterThe fields Parameter

Required FieldsRequired Fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Request Validation ErrorsRequest Validation Errors

Object Validation ErrorsObject Validation Errors

Owner Not FoundOwner Not Found

Unknown Field ErrorUnknown Field Error

Method Not FoundMethod Not Found

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Name for the Object Type

Method Parameters

The fields Parameter

Required Fields

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Request Validation Errors

Object Validation Errors

Owner Not Found

Unknown Field Error

Method Not Found

Statuses and System Error Codes

Continue Learning