Как использовать метод SDK crm.lead.delete в Битрикс24

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Как использовать метод SDK crm.lead.delete в Битрикс24», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

Описание метода SDK crm.lead.delete

Метод crm.lead.delete является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. Deletes the specified lead and all the associated objects.

Параметры и сигнатура метода

В рамках SDK метод объявлен в пространстве имен \Bitrix24\SDK\Services\CRM\Lead\Service\Lead со следующей сигнатурой:

public function delete(
      int $id
  ): Result

Пример использования на PHP

Ниже представлен готовый практический пример интеграции с использованием Bitrix24 PHP SDK. Этот пример показывает, как правильно инициализировать сервис-билдер и вызвать метод delete:

<?php
declare(strict_types=1);

use Bitrix24\SDK\Services\ServiceBuilderFactory;

// Инициализация официального Bitrix24 PHP SDK через входящий вебхук
$webhookUrl = 'https://your-portal.bitrix24.ru/rest/1/your-webhook-code/';
$serviceBuilder = ServiceBuilderFactory::createServiceBuilderFromWebhook($webhookUrl);

try {
    // Подготовка параметров для вызова метода crm.lead.delete
    $id = 123;

    // Выполнение запроса через Scope getCRMScope и сервис lead
    $result = $serviceBuilder->getCRMScope()->lead()->delete(
          $id
      );

    // Обработка полученных данных
    print_r($result->getResponseData()->getResult());

} catch (\Throwable $exception) {
    // Обработка исключений при интеграции
    echo "Ошибка при выполнении метода crm.lead.delete: " . $exception->getMessage();
}

Полезные ссылки

• Официальная REST API документация: https://training.bitrix24.com/rest_help/crm/leads/crm_lead_delete.php
• Репозиторий PHP SDK на GitHub: bitrix24-php-sdk