Изменить адрес реквизита crm.address.update
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: любой пользователь
Метод изменяет адрес для реквизита или лида.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Набор полей — объект вида Обязательно нужно указывать значения полей TYPE_ID, ENTITY_TYPE_ID, ENTITY_ID, так как они идентифицируют изменяемый адрес. Другие поля указываются, если их значения нужно изменить |
Параметр 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 будут сохранены только указанные поля, и их значения перезапишут соответствующие значения в объекте location-адреса. Такое же поведение будет и при обновлении адреса |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TYPE_ID":1,"ENTITY_TYPE_ID":3,"ENTITY_ID":1,"ADDRESS_1":"Московский проспект, 261","CITY":"Калининград"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.address.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TYPE_ID":1,"ENTITY_TYPE_ID":3,"ENTITY_ID":1,"ADDRESS_1":"Московский проспект, 261","CITY":"Калининград"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.address.update
// 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.update',
params: {
fields: {
TYPE_ID: 1, // identifies the address
ENTITY_TYPE_ID: 3, // identifies the address
ENTITY_ID: 1, // identifies the address
ADDRESS_1: 'Moskovskiy prospect, 261', // field to update
CITY: 'Kaliningrad', // field to update
},
},
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 updated:', 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 updateAddress() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.address.update',
params: {
fields: {
TYPE_ID: 1, // identifies the address
ENTITY_TYPE_ID: 3, // identifies the address
ENTITY_ID: 1, // identifies the address
ADDRESS_1: 'Moskovskiy prospect, 261', // field to update
CITY: 'Kaliningrad', // field to update
},
},
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 updated:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateAddress)
</script>
try {
$response = $b24Service
->core
->call(
'crm.address.update',
[
'fields' => [
'TYPE_ID' => 1,
'ENTITY_TYPE_ID' => 3,
'ENTITY_ID' => 1,
'ADDRESS_1' => 'Московский проспект, 261',
'CITY' => 'Калининград',
],
]
);
$result = $response
->getResponseData()
->getResult();
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating address: ' . $e->getMessage();
}
BX24.callMethod(
"crm.address.update",
{
fields:
{
"TYPE_ID": 1, //
"ENTITY_TYPE_ID": 3, // - Идентифицирующие поля.
"ENTITY_ID": 1, //
"ADDRESS_1": "Московский проспект, 261", // - Поля, значения которых меняются.
"CITY": "Калининград" //
}
},
function(result)
{
if(result.error())
console.error(result.error());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.address.update',
[
'fields' => [
'TYPE_ID' => 1,
'ENTITY_TYPE_ID' => 3,
'ENTITY_ID' => 1,
'ADDRESS_1' => 'Московский проспект, 261',
'CITY' => 'Калининград'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Пример
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.address.update(
fields={
"TYPE_ID": 1,
"ENTITY_TYPE_ID": 8,
"ENTITY_ID": 7335,
"ADDRESS_1": "25 Market Street",
"ADDRESS_2": "Floor 5",
"CITY": "Boston",
"POSTAL_CODE": "02109",
"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",
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}")
Обработка ответа
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-статус: 40x, 50x
{
"error": "",
"error_description": "ENTITY_ID is not defined or invalid."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Идентификатор типа адреса не указан или имеет недопустимое значение |
|
|
Идентификатор типа родительского объекта не указан или имеет недопустимое значение. |
|
|
Идентификатор родительского объекта не указан или имеет недопустимое значение. |
|
|
Адрес не найден |
|
|
Недостаточно прав доступа для изменения адреса |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |