метод REST scope: crm

crm.address.add

Добавить адрес

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

Описание

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

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

Параметры

fields object обязательный

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

Параметр fields

TYPE_ID integer обязательный

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

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

ENTITY_TYPE_ID integer обязательный

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

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

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

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

ENTITY_ID string обязательный

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

ADDRESS_1 string необязательный

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

ADDRESS_2 string необязательный

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

CITY string необязательный

Город

POSTAL_CODE string необязательный

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

REGION string необязательный

Район

PROVINCE string необязательный

Область

COUNTRY string необязательный

Страна

COUNTRY_CODE string необязательный

Код страны.

Не используется, оставлено для обратной совместимости. В качестве значения можно указать пустую строку

LOC_ADDR_ID integer необязательный

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

Это поле содержит идентификатор объекта адреса в модуле Location, связанного с объектов адреса CRM. Каждому адресу CRM соответствует объект адреса в модуле location. Это можно использовать для копирования существующего адреса в CRM с информацией о местоположении, которой нет в полях адреса CRM.

Если при создании адреса указан идентификатор адреса модуля location, то создается копия адреса location и привязывается к созданному адресу CRM. Если в таком случае не указаны значения для строковых полей адреса, то они будут заполнены из location-адреса.

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

Примеры запроса

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

Ответ

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

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

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

{
    "error": "",
    "error_description": "ENTITY_ID is not defined or invalid."
}
Код Описание Значение
TYPE_ID is not defined or invalid Идентификатор типа адреса не указан или имеет недопустимое значение
ENTITY_TYPE_ID is not defined or invalid Идентификатор типа родительского объекта не указан или имеет недопустимое значение.
ENTITY_ID is not defined or invalid Идентификатор родительского объекта не указан или имеет недопустимое значение
TypeAddress exists Адрес с таким типом у указанного родительского объекта уже существует
Access denied Недостаточно прав доступа для добавления адреса

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.