Skip to main content

Delete lead

Deletes a lead by ID

Function DeleteLead(Val URL, Val LeadID, Val Token = "") Export

ParameterCLI optionTypeRequiredDescription
URL--urlStringURL of webhook or a Bitrix24 domain, when token used
LeadID--leadNumber, StringLead ID
Token--tokenStringAccess 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 = "2416";

Result = OPI_Bitrix24.DeleteLead(URL, LeadID);

URL = "b24-ar17wx.bitrix24.by";
Token = "75d8c668006e9f06006b12e400000001000...";
LeadID = "2418";

Result = OPI_Bitrix24.DeleteLead(URL, LeadID, Token);
    oint bitrix24 DeleteLead \
--url ""b24-ar17wx.bitrix24.by"" \
--lead "2458" \
--token "***"
Result
{
"result": true,
"time": {
"start": 1757977059.45495,
"finish": 1757977059.69574,
"duration": 0.240790128707886,
"processing": 0.21729588508606,
"date_start": "2025-09-15T22:57:39+00:00",
"date_finish": "2025-09-15T22:57:39+00:00",
"operating_reset_at": 1757977659,
"operating": 0.217277050018311
}
}