crm.address.delete
Удалить адрес
Описание
Метод удаляет адрес.
Параметры
fields
object
обязательный
Набор полей — объект вида {"поле": "значение"[, ...]} для удаления адреса
Параметр fields
TYPE_ID
integer
обязательный
Идентификатор типа адреса. Элемент перечисления «Тип адреса».
Элементы перечисления «Тип адреса» можно получить с помощью метода crm.enum.addresstype
ENTITY_TYPE_ID
integer
обязательный
Идентификатор типа родительского объекта.
Идентификаторы типов объектов можно получить с помощью метода crm.enum.ownertype.
Адреса могут быть привязаны только к Реквизитам (а реквизиты уже к компаниям либо контактам) или Лидам.
Для обратной совместимости оставлена возможность связывать Адреса с Контактами или Компаниями. Но эта связь возможна только на некоторых старых порталах, где специально техподдержкой был включен старый режим работы с адресами
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TYPE_ID":1,"ENTITY_TYPE_ID":3,"ENTITY_ID":1}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.address.delete
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TYPE_ID":1,"ENTITY_TYPE_ID":3,"ENTITY_ID":1},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.address.delete
// 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.delete',
params: {
fields: {
TYPE_ID: 1,
ENTITY_TYPE_ID: 3,
ENTITY_ID: 1,
},
},
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 deleted:', 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 deleteAddress() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.address.delete',
params: {
fields: {
TYPE_ID: 1,
ENTITY_TYPE_ID: 3,
ENTITY_ID: 1,
},
},
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 deleted:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', deleteAddress)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.address.delete(
fields={
"TYPE_ID": 1,
"ENTITY_TYPE_ID": 8,
"ENTITY_ID": 7335,
},
).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.delete',
[
'fields' => [
'TYPE_ID' => 1,
'ENTITY_TYPE_ID' => 3,
'ENTITY_ID' => 1,
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error deleting address: ' . $e->getMessage();
}
BX24.callMethod(
"crm.address.delete",
{
fields:
{
"TYPE_ID": 1,
"ENTITY_TYPE_ID": 3,
"ENTITY_ID": 1
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.info(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.address.delete',
[
'fields' => [
'TYPE_ID' => 1,
'ENTITY_TYPE_ID' => 3,
'ENTITY_ID' => 1
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.address.delete", b24.Params{
"fields": b24.Params{
"TYPE_ID": 1,
"ENTITY_TYPE_ID": 3,
"ENTITY_ID": 1,
},
})
if err != nil {
return fmt.Errorf("crm.address.delete: %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
boolean
Результат удаления адреса:
- true — удален
- false — не удален
time
time
Информация о времени выполнения запроса
Обработка ошибок
{
"error": "",
"error_description": "TypeAddress not found."
}
| Код | Описание | Значение |
|---|---|---|
TYPE_ID is not defined or invalid |
Идентификатор типа адреса не указан или имеет недопустимое значение | |
ENTITY_TYPE_ID is not defined or invalid |
Идентификатор типа родительского объекта не указан или имеет недопустимое значение | |
ENTITY_ID is not defined or invalid |
Идентификатор родительского объекта не указан или имеет недопустимое значение | |
TypeAddress not found |
Адрес для удаления не найден | |
Access denied |
Недостаточно прав доступа для удаления адреса |

