Add Correspondence to a Natural or Legal Person sale.businessValuePersonDomain.add
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
saleWho can execute the method: administrator
The method sale.businessValuePersonDomain.add adds correspondence for the selected payer type to a natural or legal person. This is necessary for the operation of the business meanings mechanism.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Field values for creating correspondence to a natural or legal person |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
personTypeId* |
Identifier for the payer type. You can obtain the identifiers for payer types using the method sale.persontype.list |
|
domain* |
Value corresponding to the payer type: natural or legal person.
|
Code Examples
How to Use Examples in Documentation
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"personTypeId":3,"domain":"I"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.businessValuePersonDomain.add
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"personTypeId":3,"domain":"I"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.businessValuePersonDomain.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
// Shape of the payload returned in result (match the "response handling" section of the page)
type BusinessValuePersonDomainAddResult = {
businessValuePersonDomain: {
domain: string
personTypeId: number
}
}
try {
const response = await $b24.actions.v2.call.make<BusinessValuePersonDomainAddResult>({
method: 'sale.businessValuePersonDomain.add',
params: {
fields: {
personTypeId: 3,
domain: 'I',
},
},
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(result.businessValuePersonDomain.personTypeId, result.businessValuePersonDomain.domain)
}
} 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 addBusinessValuePersonDomain() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.businessValuePersonDomain.add',
params: {
fields: {
personTypeId: 3,
domain: 'I',
},
},
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(result.businessValuePersonDomain.personTypeId, result.businessValuePersonDomain.domain)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addBusinessValuePersonDomain)
</script>
require_once('crest.php');
$result = CRest::call(
'sale.businessValuePersonDomain.add',
[
'fields' =>
[
'personTypeId' => 3,
'domain' => 'I'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"businessValuePersonDomain": {
"domain": "I",
"personTypeId": 3
},
"time": {
"start": 1712325642.686926,
"finish": 1712325642.949075,
"duration": 0.2621490955352783,
"processing": 0.004400968551635742,
"date_start": "2024-04-05T16:00:42+02:00",
"date_finish": "2024-04-05T16:00:42+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
businessValuePersonDomain |
Object containing information about the added correspondence of the payer type to a natural or legal person |
|
time |
Information about the execution time of the request |
Error Handling
HTTP Status: 400
{
"error": 201450000001,
"error_description": "Duplicate entry for key [personTypeId]"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
|
|
Correspondence for the specified payer type identifier already exists |
|
|
Payer type with the specified identifier does not exist |
|
|
Access error to the record |
|
|
Parameter |
|
|
Required fields are not provided |
|
|
Other errors (e.g., fatal errors) |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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 |