метод REST scope: crm Устаревший

crm.lead.delete

Удалить лид

Устаревший метод. Развитие метода остановлено. Используйте crm.item.delete.

Кто может выполнять: любой пользователь с правом удаления лидов

Описание

Метод crm.lead.delete удаляет лид и все связанные с ним объекты: дела, история, записи таймлайна и другие.

Объекты удаляются, если они не привязаны к другим объектам или элементам. В случае, если объекты привязаны к другим элементам, удалится только привязка к удаляемому лиду.

Параметры

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

Идентификатор лида.

Идентификатор можно получить с помощью методов crm.lead.list или crm.lead.add

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":"123"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.delete

Ответ

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1705764932.998683,
        "finish": 1705764937.173995,
        "duration": 4.1753120422363281,
        "processing": 3.3076529502868652,
        "date_start": "2024-01-20T18:35:32+03:00",
        "date_finish": "2024-01-20T18:35:37+03:00",
        "operating_reset_at": 1705765533,
        "operating": 3.3076241016387939
    }
}

Возвращаемые данные

result boolean

Корневой элемент ответа, содержит true в случае успеха

time time

Информация о времени выполнения запроса

Обработка ошибок

{
  "error": "",
  "error_description": "ID is not defined or invalid."
}
Код Описание Значение
ID is not defined or invalid В параметр id либо не передано значение, либо оно является не целым числом больше нуля
Access denied У пользователя нет прав на удаление лидов
Not found Лид с переданным id не существует

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

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