crm-deal-delete.md

Удалить сделку crm.deal.delete

Scope: crm

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

Метод crm.deal.delete удаляет сделку и все связанные с ней объекты

Удаление сделки приведет к удалению всех связанных с ней объектов, таких как дела, история, дела Таймлайна и другие.

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

Параметры метода

{% include Сноска о параметрах %}

#| || Название тип | Описание || || id* integer | Идентификатор сделки.

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

{% note tip "Связанные методы и темы" %}

{#T}

{% endnote %}

Примеры кода

{% include Сноска о примерах %}

{% list tabs %}

• cURL (Webhook)

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"ID":12}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/crm.deal.delete

• cURL (OAuth)

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"ID":12,"auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/crm.deal.delete

• JS

  BX24.callMethod(
      'crm.deal.delete',
      {
          id: 12,
      },
      (result) => {
          result.error()
              ? console.error(result.error())
              : console.info(result.data())
          ;
      },
  );

• PHP

  require_once('crest.php');
  
  $result = CRest::call(
      'crm.deal.delete',
      [
          'ID' => 12
      ]
  );
  
  echo '<PRE>';
  print_r($result);
  echo '</PRE>';

{% endlist %}

Обработка ответа

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1725019350.037109,
        "finish": 1725019355.903999,
        "duration": 5.86689019203186,
        "processing": 5.262096881866455,
        "date_start": "2024-08-30T14:02:30+02:00",
        "date_finish": "2024-08-30T14:02:35+02:00",
        "operating": 0
    }
}

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

#| || Название тип | Описание || || result boolean | Корневой элемент ответа, содержит true в случае успеха || || time time | Информация о времени выполнения запроса || |#

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

HTTP-статус: 400

{
    "error": "",
    "error_description": "ID is not defined or invalid."
}

{% include notitle обработка ошибок %}

Возможные коды ошибок

#| || Описание | Значение || || ID is not defined or invalid | В параметр id либо не передано значение, либо оно является не целым числом больше нуля || || Access denied | У пользователя нет прав на «удаление» сделок || || Not found | Сделка с переданным id не существует || |#

{% include системные ошибки %}

Продолжите изучение

• {#T}
• {#T}
• {#T}
• {#T}
• {#T}