метод REST scope: crm

crm.address.delete

Удалить адрес

Кто может выполнять: пользователь с правом на удаление контакта, компании или лида — владельца адреса

Описание

Метод удаляет адрес.

Параметры

fields object обязательный

Набор полей — объект вида {"поле": "значение"[, ...]} для удаления адреса

Параметр fields

TYPE_ID integer обязательный

Идентификатор типа адреса. Элемент перечисления «Тип адреса».

Элементы перечисления «Тип адреса» можно получить с помощью метода crm.enum.addresstype

ENTITY_TYPE_ID integer обязательный

Идентификатор типа родительского объекта.

Идентификаторы типов объектов можно получить с помощью метода crm.enum.ownertype.

Адреса могут быть привязаны только к Реквизитам (а реквизиты уже к компаниям либо контактам) или Лидам.

Для обратной совместимости оставлена возможность связывать Адреса с Контактами или Компаниями. Но эта связь возможна только на некоторых старых порталах, где специально техподдержкой был включен старый режим работы с адресами

ENTITY_ID string обязательный

Идентификатор родительского объекта (реквизит или лид)

Примеры запроса

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

Ответ

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 Недостаточно прав доступа для удаления адреса

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.