Удалить адрес crm.address.delete

Scope: crm

Кто может выполнять метод: любой пользователь

Метод удаляет адрес.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

fields*
object

Набор полей — объект вида {"поле": "значение"[, ...]} для удаления адреса

Параметр fields

Обязательные параметры отмечены *

Название
тип

Описание

TYPE_ID*
integer

Идентификатор типа адреса. Элемент перечисления «Тип адреса».

Элементы перечисления «Тип адреса» можно получить с помощью метода crm.enum.addresstype

ENTITY_TYPE_ID*
integer

Идентификатор типа родительского объекта.

Идентификаторы типов объектов можно получить с помощью метода crm.enum.ownertype.

Адреса могут быть привязаны только к Реквизитам (а реквизиты уже к компаниям либо контактам) или Лидам.

Для обратной совместимости оставлена возможность связывать Адреса с Контактами или Компаниями. Но эта связь возможна только на некоторых старых порталах, где специально техподдержкой был включен старый режим работы с адресами

ENTITY_ID*
string

Идентификатор родительского объекта (реквизит или лид)

Примеры кода

Как использовать примеры в документации

Поиск адресов по привязке к типу Реквизит:

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>';

Обработка ответа

HTTP-статус: 200

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

Возвращаемые данные

Название
тип

Описание

result
boolean

Результат удаления адреса:

  • true — удален
  • false — не удален

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 40x, 50x

{
            "error": "",
            "error_description": "TypeAddress not found."
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

TYPE_ID is not defined or invalid

Идентификатор типа адреса не указан или имеет недопустимое значение

ENTITY_TYPE_ID is not defined or invalid

Идентификатор типа родительского объекта не указан или имеет недопустимое значение

ENTITY_ID is not defined or invalid

Идентификатор родительского объекта не указан или имеет недопустимое значение

TypeAddress not found

Адрес для удаления не найден

Access denied

Недостаточно прав доступа для удаления адреса

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Получить список адресов по фильтру
Следующая
Получить описание полей адреса