Delete lead
Deletes a lead by ID
Function DeleteLead(Val URL, Val LeadID, Val Token = "") Export
Parameter | CLI option | Type | Required | Description |
---|---|---|---|---|
URL | --url | String | ✔ | URL of webhook or a Bitrix24 domain, when token used |
LeadID | --lead | Number, String | ✔ | Lead 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.lead.delete
1C:Enterprise/OneScript code example
URL = "https://b24-ar17wx.bitrix24.by/rest/1/h0m...";
LeadID = "2600";
Result = OPI_Bitrix24.DeleteLead(URL, LeadID);
URL = "b24-ar17wx.bitrix24.by";
Token = "8a1bee68006e9f06006b12e400000001000...";
LeadID = "2602";
Result = OPI_Bitrix24.DeleteLead(URL, LeadID, Token);
- Bash
- CMD/Bat
oint bitrix24 DeleteLead \
--url "b24-ar17wx.bitrix24.by" \
--lead 2622 \
--token "***"
oint bitrix24 DeleteLead ^
--url "b24-ar17wx.bitrix24.by" ^
--lead 2622 ^
--token "***"
Result
{
"result": true,
"time": {
"start": 1760522603,
"finish": 1760522604.00032,
"duration": 1.00032496452332,
"processing": 1,
"date_start": "2025-10-15T10:03:23+00:00",
"date_finish": "2025-10-15T10:03:24+00:00",
"operating_reset_at": 1760523203,
"operating": 0.560378074645996
}
}