Добавить адрес crm.address.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с правом на изменение контакта, компании или лида, к которому относится адрес
DEPRECATED
Метод crm.address.add добавляет новый адрес для реквизита или лида. Для пользователя такой адрес выглядит как адрес контакта, компании или лида.
Может быть создано несколько адресов разного типа, привязанных к одному реквизиту.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Объект с полями для добавления адреса (подробное описание) |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
TYPE_ID* |
Идентификатор типа адреса. Элемент перечисления «Тип адреса». Элементы перечисления «Тип адреса» можно получить с помощью метода crm.enum.addresstype |
|
ENTITY_TYPE_ID* |
Идентификатор типа родительского объекта. Идентификаторы типов объектов можно получить с помощью метода crm.enum.ownertype. Адрес можно привязать к реквизиту ( |
|
ENTITY_ID* |
Идентификатор родительского объекта: реквизита или лида. При |
|
ADDRESS_1 |
Улица, дом, корпус, строение |
|
ADDRESS_2 |
Квартира / офис |
|
CITY |
Город |
|
POSTAL_CODE |
Почтовый индекс |
|
REGION |
Район |
|
PROVINCE |
Область |
|
COUNTRY |
Страна |
|
COUNTRY_CODE |
Код страны. Сохраняется только при точном совпадении |
|
LOC_ADDR_ID |
Идентификатор адреса местоположения. Позволяет использовать существующий адрес модуля Если строковые поля адреса не переданы, они заполняются из адреса местоположения; для создания адреса CRM хотя бы одно из них должно быть непустым. Если передано хотя бы одно из полей |
Примеры кода
Как использовать примеры в документации
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","ADDRESS_2":"Калининградский областной драматический театр","CITY":"Калининград","POSTAL_CODE":"236036","REGION":"городской округ Калининград","PROVINCE":"Калининградская область","COUNTRY":"Россия"}}' \
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","ADDRESS_2":"Калининградский областной драматический театр","CITY":"Калининград","POSTAL_CODE":"236036","REGION":"городской округ Калининград","PROVINCE":"Калининградская область","COUNTRY":"Россия"},"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',
ADDRESS_2: 'Калининградский областной драматический театр',
CITY: 'Калининград',
POSTAL_CODE: '236036',
REGION: 'городской округ Калининград',
PROVINCE: 'Калининградская область',
COUNTRY: 'Россия',
},
},
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',
ADDRESS_2: 'Калининградский областной драматический театр',
CITY: 'Калининград',
POSTAL_CODE: '236036',
REGION: 'городской округ Калининград',
PROVINCE: 'Калининградская область',
COUNTRY: 'Россия',
},
},
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": 1,
"ADDRESS_1": "проспект Мира, 4",
"ADDRESS_2": "Калининградский областной драматический театр",
"CITY": "Калининград",
"POSTAL_CODE": "236036",
"REGION": "городской округ Калининград",
"PROVINCE": "Калининградская область",
"COUNTRY": "Россия",
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'crm.address.add',
[
'fields' => [
'TYPE_ID' => 1,
'ENTITY_TYPE_ID' => 8,
'ENTITY_ID' => 1,
'ADDRESS_1' => 'проспект Мира, 4',
'ADDRESS_2' => 'Калининградский областной драматический театр',
'CITY' => 'Калининград',
'POSTAL_CODE' => '236036',
'REGION' => 'городской округ Калининград',
'PROVINCE' => 'Калининградская область',
'COUNTRY' => 'Россия',
],
]
);
$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, // Тип адреса, см. crm.enum.addresstype
"ENTITY_TYPE_ID": 8, // Тип объекта (реквизит или лид)
"ENTITY_ID": 1, // Идентификатор реквизита
"ADDRESS_1": "проспект Мира, 4",
"ADDRESS_2": "Калининградский областной драматический театр",
"CITY": "Калининград",
"POSTAL_CODE": "236036",
"REGION": "городской округ Калининград",
"PROVINCE": "Калининградская область",
"COUNTRY": "Россия",
}
},
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',
'ADDRESS_2' => 'Калининградский областной драматический театр',
'CITY' => 'Калининград',
'POSTAL_CODE' => '236036',
'REGION' => 'городской округ Калининград',
'PROVINCE' => 'Калининградская область',
'COUNTRY' => 'Россия',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
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",
"ADDRESS_2": "Калининградский областной драматический театр",
"CITY": "Калининград",
"POSTAL_CODE": "236036",
"REGION": "городской округ Калининград",
"PROVINCE": "Калининградская область",
"COUNTRY": "Россия",
},
})
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("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Обработка ответа
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1712922620.724857,
"finish": 1712922623.393783,
"duration": 2.6689260005950928,
"processing": 2.210068941116333,
"date_start": "2024-04-12T14:50:20+03:00",
"date_finish": "2024-04-12T14:50:23+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Значение Если передать только |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "ENTITY_ID is not defined or invalid."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
Пустое значение |
TYPE_ID is not defined or invalid. |
Тип адреса не указан или недопустим |
|
|
Пустое значение |
ENTITY_TYPE_ID is not defined or invalid. |
Тип родительского объекта не указан или недопустим |
|
|
Пустое значение |
ENTITY_ID is not defined or invalid. |
Идентификатор родительского объекта не указан или не является положительным числом |
|
|
Пустое значение |
TypeAddress exists. |
У родительского объекта уже есть адрес с таким типом |
|
|
Пустое значение |
Access denied. |
Нет права на изменение владельца адреса или тип родительского объекта не поддерживает добавление адреса |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Приложение Маркетплейса заблокировано, потому что число установленных приложений превышает лимит тарифа. События такому приложению не доставляются. Приложения, освобожденные от лимита, не блокируются |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Изменить адрес реквизита crm.address.update
- Получить список адресов по фильтру crm.address.list
- Удалить адрес crm.address.delete
- Получить описание полей адреса crm.address.fields
- Адреса реквизитов CRM: обзор методов
- Добавить компанию с реквизитами через веб-форму
- Добавить контакт с реквизитами через веб-форму
- Добавить сделку и компанию с реквизитами