Add Address crm.address.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:
crmWho can execute the method: a user with "add" access permission for the contact, company, or lead that owns the address
This method adds a new address for a requisite or lead. For the user, this address appears as the address of a contact, company, or lead.
Multiple addresses of different types can be created, linked to a single requisite.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
A set of fields — an object of the form |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
TYPE_ID* |
Identifier of the address type. Enumeration element "Address Type". Elements of the enumeration "Address Type" can be obtained using the method crm.enum.addresstype |
|
ENTITY_TYPE_ID* |
Identifier of the parent object's type. Identifiers of object types can be obtained using the method crm.enum.ownertype. Addresses can only be linked to Requisites (and requisites are linked to companies or contacts) or Leads. For backward compatibility, the ability to link Addresses with Contacts or Companies is retained. However, this linkage is only possible on some older accounts where the old address handling mode was specifically enabled by technical support. |
|
ENTITY_ID* |
|
|
ADDRESS_1 |
Street, house, building, structure |
|
ADDRESS_2 |
Apartment / office |
|
CITY |
City |
|
POSTAL_CODE |
Postal code |
|
REGION |
District |
|
PROVINCE |
State |
|
COUNTRY |
Country |
|
COUNTRY_CODE |
Country code. Not used, retained for backward compatibility. An empty string can be specified as a value. |
|
LOC_ADDR_ID |
Identifier of the location address. This field contains the identifier of the address object in the If the identifier of the If at least one string field is specified, only the specified fields will be saved in the CRM address, and their values will overwrite the corresponding values in the location address object. The same behavior will occur when updating the address. |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TYPE_ID":1,"ENTITY_TYPE_ID":8,"ENTITY_ID":1,"ADDRESS_1":"4 Peace Avenue","ADDRESS_2":"Drama Theater","CITY":"City","POSTAL_CODE":"000000","REGION":"Urban District","PROVINCE":"Region","COUNTRY":"USA"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.address.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TYPE_ID":1,"ENTITY_TYPE_ID":8,"ENTITY_ID":1,"ADDRESS_1":"4 Peace Avenue","ADDRESS_2":"Drama Theater","CITY":"City","POSTAL_CODE":"000000","REGION":"Urban District","PROVINCE":"Region","COUNTRY":"USA"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.address.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<boolean>({
method: 'crm.address.add',
params: {
fields: {
TYPE_ID: 1, // Address type, see crm.enum.addresstype
ENTITY_TYPE_ID: 8, // Parent object type (requisite or lead)
ENTITY_ID: 1, // Requisite identifier
ADDRESS_1: '4 Peace Avenue',
ADDRESS_2: 'Drama Theater',
CITY: 'City',
REGION: 'City urban district',
PROVINCE: 'Region',
COUNTRY: 'USA',
},
},
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('Address added:', 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 addAddress() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.address.add',
params: {
fields: {
TYPE_ID: 1, // Address type, see crm.enum.addresstype
ENTITY_TYPE_ID: 8, // Parent object type (requisite or lead)
ENTITY_ID: 1, // Requisite identifier
ADDRESS_1: '4 Peace Avenue',
ADDRESS_2: 'Drama Theater',
CITY: 'City',
REGION: 'City urban district',
PROVINCE: 'Region',
COUNTRY: 'USA',
},
},
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('Address added:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addAddress)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.address.add(
fields={
"TYPE_ID": 1,
"ENTITY_TYPE_ID": 8,
"ENTITY_ID": 7335,
"ADDRESS_1": "15 Main Street",
"ADDRESS_2": "Suite 300",
"CITY": "Boston",
"POSTAL_CODE": "02110",
"REGION": "Suffolk County",
"PROVINCE": "Massachusetts",
"COUNTRY": "United States",
"COUNTRY_CODE": "US",
},
).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.address.add',
[
'fields' => [
'TYPE_ID' => 1,
'ENTITY_TYPE_ID' => 8,
'ENTITY_ID' => 1,
'ADDRESS_1' => '4 Peace Avenue',
'ADDRESS_2' => 'Drama Theater',
'CITY' => 'City',
'POSTAL_CODE' => '00000',
'REGION' => 'Urban District',
'PROVINCE' => 'Region',
'COUNTRY' => 'USA',
],
]
);
$result = $response
->getResponseData()
->getResult();
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding address: ' . $e->getMessage();
}
BX24.callMethod(
"crm.address.add",
{
fields:
{
"TYPE_ID": 1, // Address type, see crm.enum.addresstype
"ENTITY_TYPE_ID": 8, // Object type (requisite or lead)
"ENTITY_ID": 1, // Identifier of the requisite
"ADDRESS_1": "4 Peace Avenue",
"ADDRESS_2": "Drama Theater",
"CITY": "City",
"POSTAL_CODE": "00000",
"REGION": "Urban District",
"PROVINCE": "Region",
"COUNTRY": "USA",
}
},
function(result)
{
if(result.error())
console.error(result.error());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.address.add',
[
'fields' => [
'TYPE_ID' => 1,
'ENTITY_TYPE_ID' => 8,
'ENTITY_ID' => 1,
'ADDRESS_1' => '4 Peace Avenue',
'ADDRESS_2' => 'Drama Theater',
'CITY' => 'City',
'POSTAL_CODE' => '00000',
'REGION' => 'Urban District',
'PROVINCE' => 'Region',
'COUNTRY' => 'USA',
]
]
);
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.address.add", b24.Params{
"fields": b24.Params{
"TYPE_ID": 1,
"ENTITY_TYPE_ID": 8,
"ENTITY_ID": 1,
"ADDRESS_1": "4 Peace Avenue",
"ADDRESS_2": "Drama Theater",
"CITY": "City",
"POSTAL_CODE": "236036",
"REGION": "Urban District",
"PROVINCE": "Region",
"COUNTRY": "USA",
},
})
if err != nil {
return fmt.Errorf("crm.address.add: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("done:", ok)
Response Handling
HTTP status: 200
{
"result": true,
"time": {
"start": 1712922620.724857,
"finish": 1712922623.393783,
"duration": 2.6689260005950928,
"processing": 2.210068941116333,
"date_start": "2024-04-12T14:50:20+02:00",
"date_finish": "2024-04-12T14:50:23+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Result of adding the address:
|
|
time |
Information about the request execution time |
Error Handling
HTTP status: 40x, 50x
{
"error": "",
"error_description": "ENTITY_ID is not defined or invalid."
}
|
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
|
Code |
Description |
|
|
Address type identifier is not specified or has an invalid value |
|
|
Parent object type identifier is not specified or has an invalid value. |
|
|
Parent object identifier is not specified or has an invalid value |
|
|
An address of this type already exists for the specified parent object |
|
|
Insufficient access permissions to add the address |
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
- Update Address for crm.address.update
- Get a List of Addresses by Filter crm.address.list
- Delete address crm.address.delete
- Get Description of Address Fields crm.address.fields
- Add a Company with Requisites via Web Form
- Add a Contact with Requisites via Web Form
- Add a Deal and Company with Requisites