Add a Contact or Company Address v 3.0 crm.[type].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 permission to edit the contact or company to which the address 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>.address.add method adds an address to a contact or company and returns the address ID. The owner type is set by the <type> segment of the method name. The address is stored in an owner's requisite: if there are no requisites, CRM creates a requisite to store the address.
Method Name for the Object Type
|
Object type |
Method |
|
Contact |
|
|
Company |
|
A lead address is set by the crm.lead.address.set method.
The method name is written in lowercase: crm.company.address.add, not crm.Company.address.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 |
Description |
|
fields* |
Object with the address fields in the format An address has required fields |
The fields Parameter
Required parameters are marked with *
|
Name |
Description |
|
contactId* |
Contact ID. Passed in The ID can be retrieved with the crm.<type>.list method |
|
companyId* |
Company ID. Passed in The ID can be retrieved with the crm.<type>.list method |
|
typeId* |
Address type. Possible values:
The list of types is returned by the crm.dictionary.addresstype.list method. An owner can have only one address of each type |
|
address1 |
Street, building, block, structure |
|
address2 |
Apartment or office |
|
city |
City |
|
postalCode |
Postal code |
|
region |
District |
|
province |
Region |
|
country |
Country |
|
countryCode |
Country code from the Bitrix24 locations reference. The code is checked against the country name in |
The id and requisiteId fields are read-only. CRM chooses the requisite for the address itself: a requisite with an address of the same type, the requisite selected in the owner form, or the first requisite. To add an address to a specific requisite, use the crm.<type>.requisite.address.add method.
Required Fields
Without these fields, the method returns an error and does not create the address:
|
Object type |
Required |
|
Contact |
|
|
Company |
|
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.contact.address.add
The examples add a street address to a contact. For a company, replace the method name according to the table above and pass companyId instead of contactId.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"contactId":3219,"typeId":1,"address1":"Friedrichstraße 1","city":"Berlin","postalCode":"10117","country":"Germany"}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.contact.address.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"contactId":3219,"typeId":1,"address1":"Friedrichstraße 1","city":"Berlin","postalCode":"10117","country":"Germany"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.contact.address.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 AddressAddResult = {
id: number
}
try {
const response = await $b24.getHttpClient(ApiVersion.v3).call<AddressAddResult>(
'crm.contact.address.add',
{
fields: {
contactId: 3219,
typeId: 1,
address1: 'Friedrichstraße 1',
city: 'Berlin',
postalCode: '10117',
country: 'Germany',
},
},
Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Address 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 addAddress() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
'crm.contact.address.add',
{
fields: {
contactId: 3219,
typeId: 1,
address1: 'Friedrichstraße 1',
city: 'Berlin',
postalCode: '10117',
country: 'Germany',
},
},
B24Js.Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Address created:', result.id)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addAddress)
</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.contact.address.add"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})
try:
response = bitrix_token.call_method(
api_method=method,
params={
"fields": {
"contactId": 3219,
"typeId": 1,
"address1": "Friedrichstraße 1",
"city": "Berlin",
"postalCode": "10117",
"country": "Germany",
},
},
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.contact.address.add',
[
'fields' => [
'contactId' => 3219,
'typeId' => 1,
'address1' => 'Friedrichstraße 1',
'city' => 'Berlin',
'postalCode' => '10117',
'country' => 'Germany',
],
]
);
$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.contact.address.add',
{
fields: {
contactId: 3219,
typeId: 1,
address1: 'Friedrichstraße 1',
city: 'Berlin',
postalCode: '10117',
country: 'Germany',
},
},
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.contact.address.add',
[
'fields' => [
'contactId' => 3219,
'typeId' => 1,
'address1' => 'Friedrichstraße 1',
'city' => 'Berlin',
'postalCode' => '10117',
'country' => 'Germany',
],
]
);
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.contact.address.add", b24.Params{
"fields": b24.Params{
"contactId": 3219,
"typeId": 1,
"address1": "Friedrichstraße 1",
"city": "Berlin",
"postalCode": "10117",
"country": "Germany",
},
})
if err != nil {
return fmt.Errorf("crm.contact.address.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": 633
},
"time": {
"start": 1793709949,
"finish": 1793709949.853585,
"duration": 0.8535850048065186,
"processing": 0,
"date_start": "2026-11-03T15:45:49+03:00",
"date_finish": "2026-11-03T15:45:49+03:00",
"operating_reset_at": 1793710260,
"operating": 0.3442521095275879
}
}
Returned Data
|
Name |
Description |
|
result |
Object with response data |
|
result.id |
ID of the created address. The address and the requisite in which it is stored can be retrieved with the crm.<type>.address.get method |
|
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": "An address of this type already exists. Select another type.",
"field": "typeId"
}
]
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
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 |
|
|
Required field |
Pass the |
|
|
Fill in at least one address field |
Pass at least one of the |
|
|
An address of this type already exists. Select another type |
Update the existing address with the crm.<type>.address.update method or pass a different |
|
|
Unknown address type. Check the value |
Pass a type from crm.dictionary.addresstype.list |
|
|
The country code does not match the country name. Check both fields |
Pass the country name in the Bitrix24 language in |
|
|
The details to store the address could not be created |
The owner has no requisites, and CRM could not create one. Create a requisite with the crm.<type>.requisite.add method and repeat the request. In |
Object Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Required field |
Pass the owner ID: |
|
|
Required field |
Pass the address type |
|
|
Field |
Remove the read-only field from |
Owner Not Found
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Entity with ID |
There is no contact or company with this ID, or you do not have 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 |
Check the field name against the fields parameter table. The contact method does not accept |
Method Not Found
Error Code: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP status: 404
|
Field |
Error description |
How to Fix |
|
|
Method |
Check the method name: it is written in lowercase, for example, |
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 |