Add Correspondence to a Natural or Legal Person sale.businessValuePersonDomain.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:
saleWho can execute the method: administrator
The method sale.businessValuePersonDomain.add sets the correspondence of a payer type to a natural or legal person. Without a correspondence, the payer type is not included in the business meanings settings.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Fields of the new correspondence (detailed description) |
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* |
Who pays under this payer type:
|
Code Examples
How to Use Examples in Documentation
curl -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
curl -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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
fields = {
"personTypeId": 3,
"domain": "I",
}
try:
bitrix_response = client.sale.businessvaluepersondomain.add(
fields=fields,
).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(
'sale.businessValuePersonDomain.add',
[
'fields' => [
'personTypeId' => 3,
'domain' => 'I',
],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'sale.businessValuePersonDomain.add',
{
fields: {
personTypeId: 3,
domain: 'I'
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.businessValuePersonDomain.add',
[
'fields' =>
[
'personTypeId' => 3,
'domain' => 'I'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "sale.businessValuePersonDomain.add", b24.Params{
"fields": b24.Params{
"personTypeId": 3,
"domain": "I",
},
})
if err != nil {
return fmt.Errorf("sale.businessValuePersonDomain.add: %w", err)
}
// The response arrives as json.RawMessage — unmarshal it
// into a struct matching the response shape shown below on this page.
fmt.Printf("%s\n", res.Result)
Response Handling
HTTP Status: 200
{
"result": {
"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 (detailed description) |
|
time |
Information about the execution time of the request |
Object result
|
Name |
Description |
|
businessValuePersonDomain |
The added correspondence |
Error Handling
HTTP Status: 400
{
"error": "201450000001",
"error_description": "Duplicate entry for key [personTypeId]"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Duplicate entry for key [personTypeId] |
The payer type already has a correspondence. To change the domain, delete the correspondence using sale.businessValuePersonDomain.deleteByFilter and add it again |
|
|
|
person type is not exists |
The payer type with the specified identifier does not exist |
|
|
|
Access Denied |
No permission to change the correspondence |
|
|
|
Could not find value for parameter |
The |
|
|
|
Required fields: |
The required fields |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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
- Statuses of Payer Types in the Online Store: Overview of Methods
- Get a list of matches for a natural or legal person sale.businessValuePersonDomain.list
- Delete the correspondence with a natural or legal person sale.businessValuePersonDomain.deleteByFilter
- Get Fields Corresponding to a Natural or Legal Person sale.businessValuePersonDomain.getFields