Delete lead crm.lead.delete

Scope: crm

Who can execute the method: any user with permission to delete leads

Method Development Stopped

The method crm.lead.delete continues to function, but there is a more relevant alternative crm.item.delete.

The method crm.lead.delete removes a lead and all associated objects: activities, history, timeline records, and others.

Objects are deleted if they are not linked to other objects or entities. If the objects are linked to other entities, only the link to the deleted lead will be removed.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

The identifier of the lead.

The identifier can be obtained using the methods crm.lead.list or crm.lead.add

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":"123"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.delete

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

try
        {
            const id = prompt("Enter ID");
            const response = await $b24.callMethod(
                'crm.lead.delete',
                { id }
            );
            
            const result = response.getData().result;
            if(result.error())
            {
                console.error(result.error());
                return;
            }
            
            console.info(result);
        }
        catch(error)
        {
            console.error('Error:', error);
        }

try {
            $id = 123; // Example lead ID to delete
            $result = $serviceBuilder
                ->getCRMScope()
                ->lead()
                ->delete($id);
            if ($result->isSuccess()) {
                print("Lead with ID $id has been successfully deleted.");
            } else {
                print("Failed to delete lead with ID $id.");
            }
        } catch (Throwable $e) {
            print("An error occurred: " . $e->getMessage());
        }

const id = prompt("Enter ID");
        BX24.callMethod(
          'crm.lead.delete',
          { id },
          (result) => {
            if(result.error())
            {
              console.error(result.error());
        
              return;
            }
            
            console.info(result.data());
          }
        );

require_once('crest.php');
        
        $id = readline("Enter ID: ");
        
        $result = CRest::call(
            'crm.lead.delete',
            [
                'id' => $id
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1705764932.998683,
                "finish": 1705764937.173995,
                "duration": 4.1753120422363281,
                "processing": 3.3076529502868652,
                "date_start": "2024-01-20T18:35:32+01:00",
                "date_finish": "2024-01-20T18:35:37+01:00",
                "operating_reset_at": 1705765533,
                "operating": 3.3076241016387939
            }
        }

Returned Data

Name `type`	Description
result `boolean`	The root element of the response, contains `true` in case of success
time `time`	Information about the execution time of the request

Error Handling

40x, 50x Error

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

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Description	Value
`ID is not defined or invalid`	The `id` parameter either has no value or is not a positive integer
`Access denied`	The user does not have permission to delete leads
`Not found`	The lead with the provided `id` does not exist

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Get List of Leads

Get Lead Fields

Delete lead crm.lead.delete

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes