1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2026-05-22 10:05:29 +02:00
Files
OpenIntegrations/docs/en/md/Bitrix24/Leads-managment/Delete-lead.mdx
T
Vitaly the Alpaca (bot) 6473088320 Main build (Jenkins)
2024-11-05 13:10:27 +03:00

83 lines
1.9 KiB
Plaintext

---
sidebar_position: 2
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# 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
<br/>
:::tip
Method at API documentation: [crm.lead.delete](https://dev.1c-bitrix.ru/rest_help/crm/leads/crm_lead_delete.php)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "https://b24-ar17wx.bitrix24.by/rest/1/yg2...";
LeadID = "648";
Result = OPI_Bitrix24.DeleteLead(URL, LeadID);
URL = "b24-ar17wx.bitrix24.by";
Token = "82d42767006e9f06006b12e400000001000...";
LeadID = "650";
Result = OPI_Bitrix24.DeleteLead(URL, LeadID, Token);
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint bitrix24 DeleteLead \
--url "b24-ar17wx.bitrix24.by" \
--lead 630 \
--token "***"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint bitrix24 DeleteLead ^
--url "b24-ar17wx.bitrix24.by" ^
--lead 630 ^
--token "***"
```
</TabItem>
</Tabs>
```json title="Result"
{
"result": true,
"time": {
"start": 1728454943.26955,
"finish": 1728454943.58409,
"duration": 0.314532041549683,
"processing": 0.281855821609497,
"date_start": "2024-10-09T09:22:23+03:00",
"date_finish": "2024-10-09T09:22:23+03:00",
"operating_reset_at": 1728455543,
"operating": 0.281836032867432
}
}
```