Delete address crm.address.delete

Scope: crm

Who can execute the method: any user

The method deletes an address.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	A set of fields — an object of the form `{"field": "value"[, ...]}` for deleting the address

Parameter fields

Required parameters are marked with *

Name `type`	Description
TYPE_ID* `integer`	Identifier of the address type. Enumeration element "Address Type". Enumeration elements for "Address Type" can be obtained using the method crm.enum.addresstype
ENTITY_TYPE_ID* `integer`	Identifier of the parent object's type. Identifiers for object types can be obtained using the method crm.enum.ownertype. Addresses can only be linked to Details (which are already linked to companies or contacts) or Leads. For backward compatibility, the ability to link Addresses to Contacts or Companies has been retained. However, this linkage is only possible on some older accounts where the old address handling mode was specifically enabled by technical support.
ENTITY_ID* `string`	Identifier of the parent object (detail or lead)

Code Examples

How to Use Examples in Documentation

Searching for addresses linked to the Detail type:

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"TYPE_ID":1,"ENTITY_TYPE_ID":3,"ENTITY_ID":1}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.address.delete

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"TYPE_ID":1,"ENTITY_TYPE_ID":3,"ENTITY_ID":1},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.address.delete

try
        {
        	const response = await $b24.callMethod(
        		"crm.address.delete",
        		{
        			fields:
        			{
        				"TYPE_ID": 1,
        				"ENTITY_TYPE_ID": 3,
        				"ENTITY_ID": 1
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	if(result.error())
        		console.error(result.error());
        	else
        		console.info(result);
        }
        catch(error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.address.delete',
                    [
                        'fields' => [
                            'TYPE_ID'       => 1,
                            'ENTITY_TYPE_ID' => 3,
                            'ENTITY_ID'     => 1,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error deleting address: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.address.delete",
            {
                fields:
                {
                    "TYPE_ID": 1,
                    "ENTITY_TYPE_ID": 3,
                    "ENTITY_ID": 1
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.info(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.address.delete',
            [
                'fields' => [
                    'TYPE_ID' => 1,
                    'ENTITY_TYPE_ID' => 3,
                    'ENTITY_ID' => 1
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1712922620.724857,
                "finish": 1712922623.393783,
                "duration": 2.6689260005950928,
                "processing": 2.210068941116333,
                "date_start": "2024-04-12T14:50:20+02:00",
                "date_finish": "2024-04-12T14:50:23+02:00"
            }
        }

Returned Data

Name
type

Description

result
boolean

Result of the address deletion:

true — deleted
false — not deleted

time
time

Information about the request execution time

Error Handling

HTTP status: 40x, 50x

{
            "error": "",
            "error_description": "TypeAddress 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
`TYPE_ID is not defined or invalid`	The address type identifier is not specified or has an invalid value
`ENTITY_TYPE_ID is not defined or invalid`	The parent object type identifier is not specified or has an invalid value
`ENTITY_ID is not defined or invalid`	The parent object identifier is not specified or has an invalid value
`TypeAddress not found`	The address to delete was not found
`Access denied`	Insufficient access permissions to delete the address

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 addresses by filter

Get description of address fields

Delete address crm.address.delete

Method ParametersMethod Parameters

Parameter fieldsParameter fields

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

Continue LearningContinue Learning