Delete deal

Deletes deal by ID

Function DeleteDeal(Val URL, Val DealID, Val Token = "") Export

Parameter	CLI option	Type	Required	Description
URL	--url	String	✔	URL of webhook or a Bitrix24 domain, when token used
DealID	--deal	Number, String	✔	Deal ID
Token	--token	String	✖	Access token, when app auth method used

Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API

tip

Method at API documentation: crm.deal.delete

1C:Enterprise/OneScript code example

    URL    = "https://b24-ar17wx.bitrix24.by/rest/1/yg2...";
    DealID = "1696";

    Result = OPI_Bitrix24.DeleteDeal(URL, DealID);

    URL    = "b24-ar17wx.bitrix24.by";
    Token  = "2f4e4067006e9f06006b12e400000001000...";
    DealID = "1698";

    Result = OPI_Bitrix24.DeleteDeal(URL, DealID, Token);

Bash

    oint bitrix24 DeleteDeal \
     --url "b24-ar17wx.bitrix24.by" \
     --deal 1730 \
     --token "***"

CMD/Bat

    oint bitrix24 DeleteDeal ^
     --url "b24-ar17wx.bitrix24.by" ^
     --deal 1730 ^
     --token "***"

Result

{
 "result": true,
 "time": {
  "start": 1728454947.97132,
  "finish": 1728454948.11192,
  "duration": 0.14059591293335,
  "processing": 0.103829860687256,
  "date_start": "2024-10-09T09:22:27+03:00",
  "date_finish": "2024-10-09T09:22:28+03:00",
  "operating_reset_at": 1728455548,
  "operating": 0.103808164596558
 }
}