Delete CRM Item - crm.item.delete

Scope: crm

Who can execute the method: any user with the "delete" access permission for CRM object items

This method deletes a CRM object item by its item ID and item type ID.

Method Parameters

Required parameters are marked with *

Name
type

Description

entityTypeId*
integer

The ID of the system or user-defined type whose item we want to delete

id*
integer

The ID of the item to be deleted.

This can be obtained using the crm.item.list method or when creating an item with crm.item.add

Code Examples

How to Use Examples in Documentation

Deleting an item with id = 1, belonging to a smart process with entityTypeId = 1268

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

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

try
        {
        	const response = await $b24.callMethod(
        		'crm.item.delete',
        		{
        			entityTypeId: 1268,
        			id: 1,
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.item.delete',
                    [
                        'entityTypeId' => 1268,
                        'id'           => 1,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                return;
            }
        
            echo 'Success: ' . print_r($result->data(), true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error deleting item: ' . $e->getMessage();
        }

    BX24.callMethod(
                'crm.item.delete',
                {
                    entityTypeId: 1268,
                    id: 1,
                },
                (result) => {
                    if (result.error())
                    {
                        console.error(result.error());
        
                        return;
                    }
        
                    console.info(result.data());
                },
            );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.item.delete',
            [
                'entityTypeId' => 1268,
                'id' => 1
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": [],
            "time": {
                "start": 1721657688.755373,
                "finish": 1721657689.65017,
                "duration": 0.8947970867156982,
                "processing": 0.6092040538787842,
                "date_start": "2024-07-22T16:14:48+02:00",
                "date_finish": "2024-07-22T16:14:49+02:00",
                "operating": 0
            }
        }

Returned Values

Name
type

Description

result
array

The root element of the response.

Returns an empty array [] in case of success

time
time

Information about the request execution time

Error Handling

HTTP status: 400, 403

{
            "error": "NOT_FOUND",
            "error_description": "Item not found"
        }

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

Code	Description	Value
`allowed_only_intranet_user`	Action allowed only for intranet users	User is not an intranet user
`NOT_FOUND`	Smart process not found	Occurs when an invalid `entityTypeId` is passed
`NOT_FOUND`	Item not found	An item with the given `id` of type `entityTypeId` does not exist
`ACCESS_DENIED`	Access denied	User does not have permission to delete items of type `entityTypeId`

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

Continue Learning

Get List of Entities

Get Entity Fields

Delete CRM Item - crm.item.delete

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned ValuesReturned Values

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning