Добавить адрес crm.address.add

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: пользователь с правом на изменение контакта, компании или лида, к которому относится адрес

DEPRECATED

Развитие метода остановлено. Используйте методы REST 3.0: адреса контактов, компаний и лидов — в группе Адреса, адреса реквизитов — в группе Реквизиты.

Метод crm.address.add добавляет новый адрес для реквизита или лида. Для пользователя такой адрес выглядит как адрес контакта, компании или лида.

Может быть создано несколько адресов разного типа, привязанных к одному реквизиту.

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

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

Название
тип

Описание

fields*
object

Объект с полями для добавления адреса (подробное описание)

Параметр fields

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

Название
тип

Описание

TYPE_ID*
integer

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

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

ENTITY_TYPE_ID*
integer

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

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

Адрес можно привязать к реквизиту (8) или лиду (1). Для обратной совместимости можно передать компанию (4) или контакт (3): адрес сохранится в реквизите, где у этой компании или контакта уже есть основной адрес того же типа. Если такого нет — в реквизите, выбранном в карточке, иначе в первом реквизите по возрастанию SORT и ID. Если реквизитов нет, Битрикс24 создаст новый

ENTITY_ID*
integer

Идентификатор родительского объекта: реквизита или лида. При ENTITY_TYPE_ID=4 или 3 передайте идентификатор компании или контакта соответственно

ADDRESS_1
string

Улица, дом, корпус, строение

ADDRESS_2
string

Квартира / офис

CITY
string

Город

POSTAL_CODE
string

Почтовый индекс

REGION
string

Район

PROVINCE
string

Область

COUNTRY
string

Страна

COUNTRY_CODE
string

Код страны. Сохраняется только при точном совпадении COUNTRY с названием страны для этого кода. Если COUNTRY не передан или не совпадает, код очищается

LOC_ADDR_ID
integer

Идентификатор адреса местоположения.

Позволяет использовать существующий адрес модуля location, в том числе данные, которых нет в полях адреса CRM. Если адрес местоположения уже связан с другим объектом, создается его копия.

Если строковые поля адреса не переданы, они заполняются из адреса местоположения; для создания адреса CRM хотя бы одно из них должно быть непустым. Если передано хотя бы одно из полей ADDRESS_1, ADDRESS_2, CITY, POSTAL_CODE, REGION, PROVINCE, COUNTRY, в CRM сохраняются только переданные поля. Они также обновляют соответствующие поля адреса местоположения

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TYPE_ID":1,"ENTITY_TYPE_ID":8,"ENTITY_ID":1,"ADDRESS_1":"проспект Мира, 4","ADDRESS_2":"Калининградский областной драматический театр","CITY":"Калининград","POSTAL_CODE":"236036","REGION":"городской округ Калининград","PROVINCE":"Калининградская область","COUNTRY":"Россия"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.address.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TYPE_ID":1,"ENTITY_TYPE_ID":8,"ENTITY_ID":1,"ADDRESS_1":"проспект Мира, 4","ADDRESS_2":"Калининградский областной драматический театр","CITY":"Калининград","POSTAL_CODE":"236036","REGION":"городской округ Калининград","PROVINCE":"Калининградская область","COUNTRY":"Россия"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.address.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

try {
  const response = await $b24.actions.v2.call.make<boolean>({
    method: 'crm.address.add',
    params: {
      fields: {
        TYPE_ID: 1,            // Address type, see crm.enum.addresstype
        ENTITY_TYPE_ID: 8,     // Parent object type (requisite or lead)
        ENTITY_ID: 1,          // Requisite identifier
        ADDRESS_1: 'проспект Мира, 4',
        ADDRESS_2: 'Калининградский областной драматический театр',
        CITY: 'Калининград',
        POSTAL_CODE: '236036',
        REGION: 'городской округ Калининград',
        PROVINCE: 'Калининградская область',
        COUNTRY: 'Россия',
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Address added:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function addAddress() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.address.add',
        params: {
          fields: {
            TYPE_ID: 1,            // Address type, see crm.enum.addresstype
            ENTITY_TYPE_ID: 8,     // Parent object type (requisite or lead)
            ENTITY_ID: 1,          // Requisite identifier
            ADDRESS_1: 'проспект Мира, 4',
            ADDRESS_2: 'Калининградский областной драматический театр',
            CITY: 'Калининград',
            POSTAL_CODE: '236036',
            REGION: 'городской округ Калининград',
            PROVINCE: 'Калининградская область',
            COUNTRY: 'Россия',
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Address added:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addAddress)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.address.add(
        fields={
            "TYPE_ID": 1,
            "ENTITY_TYPE_ID": 8,
            "ENTITY_ID": 1,
            "ADDRESS_1": "проспект Мира, 4",
            "ADDRESS_2": "Калининградский областной драматический театр",
            "CITY": "Калининград",
            "POSTAL_CODE": "236036",
            "REGION": "городской округ Калининград",
            "PROVINCE": "Калининградская область",
            "COUNTRY": "Россия",
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $response = $b24Service
        ->core
        ->call(
            'crm.address.add',
            [
                'fields' => [
                    'TYPE_ID'        => 1,
                    'ENTITY_TYPE_ID' => 8,
                    'ENTITY_ID'      => 1,
                    'ADDRESS_1'      => 'проспект Мира, 4',
                    'ADDRESS_2'      => 'Калининградский областной драматический театр',
                    'CITY'           => 'Калининград',
                    'POSTAL_CODE'    => '236036',
                    'REGION'         => 'городской округ Калининград',
                    'PROVINCE'       => 'Калининградская область',
                    'COUNTRY'        => 'Россия',
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error adding address: ' . $e->getMessage();
}
BX24.callMethod(
    "crm.address.add",
    {
        fields:
        {
            "TYPE_ID": 1,            // Тип адреса, см. crm.enum.addresstype
            "ENTITY_TYPE_ID": 8,     // Тип объекта (реквизит или лид)
            "ENTITY_ID": 1,          // Идентификатор реквизита
            "ADDRESS_1": "проспект Мира, 4",
            "ADDRESS_2": "Калининградский областной драматический театр",
            "CITY": "Калининград",
            "POSTAL_CODE": "236036",
            "REGION": "городской округ Калининград",
            "PROVINCE": "Калининградская область",
            "COUNTRY": "Россия",
        }
    },
    function(result)
    {
        if(result.error())
            console.error(result.error());
    }
);
require_once('crest.php');

$result = CRest::call(
    'crm.address.add',
    [
        'fields' => [
            'TYPE_ID' => 1,
            'ENTITY_TYPE_ID' => 8,
            'ENTITY_ID' => 1,
            'ADDRESS_1' => 'проспект Мира, 4',
            'ADDRESS_2' => 'Калининградский областной драматический театр',
            'CITY' => 'Калининград',
            'POSTAL_CODE' => '236036',
            'REGION' => 'городской округ Калининград',
            'PROVINCE' => 'Калининградская область',
            'COUNTRY' => 'Россия',
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.address.add", b24.Params{
	"fields": b24.Params{
		"TYPE_ID":        1,
		"ENTITY_TYPE_ID": 8,
		"ENTITY_ID":      1,
		"ADDRESS_1":      "проспект Мира, 4",
		"ADDRESS_2":      "Калининградский областной драматический театр",
		"CITY":           "Калининград",
		"POSTAL_CODE":    "236036",
		"REGION":         "городской округ Калининград",
		"PROVINCE":       "Калининградская область",
		"COUNTRY":        "Россия",
	},
})
if err != nil {
	return fmt.Errorf("crm.address.add: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)

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

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 означает, что запрос выполнен без ошибки.

Если передать только TYPE_ID, ENTITY_TYPE_ID и ENTITY_ID, метод вернет true, но адрес не создастся. Передайте непустое текстовое поле адреса или LOC_ADDR_ID адреса местоположения с непустыми полями адреса, затем проверьте результат методом crm.address.list

time
time

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

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

400

Пустое значение

TYPE_ID is not defined or invalid.

Тип адреса не указан или недопустим

400

Пустое значение

ENTITY_TYPE_ID is not defined or invalid.

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

400

Пустое значение

ENTITY_ID is not defined or invalid.

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

400

Пустое значение

TypeAddress exists.

У родительского объекта уже есть адрес с таким типом

400

Пустое значение

Access denied.

Нет права на изменение владельца адреса или тип родительского объекта не поддерживает добавление адреса

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

403

FEATURE_NOT_AVAILABLE_ON_CURRENT_PLAN
Функция недоступна на текущем тарифе.

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

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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