Delete additional property of storage items entity.item.property.delete

We are still updating this page

Some data may be missing — we will complete it shortly

Scope: entity

Who can execute the method: any user

The method deletes additional properties of storage items. The user must have management rights (X) for the storage.

Parameters

Parameter

Description

ENTITY*
string

Required. String identifier of the storage.

PROPERTY*
string

Required. String identifier of the property.

Required parameters are marked with *

Examples

try
        {
        	const response = await $b24.callMethod(
        		'entity.item.property.delete',
        		{
        			ENTITY: 'menu_new',
        			PROPERTY: 'new_prop'
        		}
        	);
        	
        	const result = response.getData().result;
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'entity.item.property.delete',
                    [
                        'ENTITY'   => 'menu_new',
                        'PROPERTY' => 'new_prop',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error deleting entity item property: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'entity.item.property.delete',
            {
                ENTITY: 'menu_new',
                PROPERTY: 'new_prop'
            }
        );
        
https://my.bitrix24.com/rest/entity.item.property.delete.json?ENTITY=menu_new&PROPERTY=new_prop&auth=d92dd12b9b9b904254776104eed2bb76
        

How to Use Examples in Documentation

Response on success

200 OK

{"result":true}