Добавить адрес реквизита v 3.0 crm.<тип>.requisite.address.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с правом на изменение контакта или компании, которой принадлежит реквизит
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод crm.<тип>.requisite.address.add добавляет адрес к реквизиту контакта или компании и возвращает пару requisiteId и typeId, по которой адрес находят в других методах.
Имя метода для типа объекта
|
Тип объекта |
Метод |
|
Компания |
|
|
Контакт |
|
Адрес реквизита определяет пара requisiteId и typeId: у реквизита может быть только один адрес каждого типа, отдельного идентификатора у адреса нет. Сегмент company или contact в имени метода должен совпадать с владельцем реквизита.
Имя метода пишется в нижнем регистре: crm.company.requisite.address.add, а не crm.company.requisite.Address.Add. На имя в другом регистре метод отвечает ошибкой «Метод не найден».
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Объект с полями адреса. Обязательные поля —
Поля адреса: |
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/crm.company.requisite.address.add
Примеры добавляют юридический адрес к реквизиту компании 549. Для контакта замените имя метода на crm.contact.requisite.address.add.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"requisiteId":549,"typeId":6,"address1":"ул. Тверская, д. 1","city":"Москва","postalCode":"125009","country":"Россия"}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.company.requisite.address.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"requisiteId":549,"typeId":6,"address1":"ул. Тверская, д. 1","city":"Москва","postalCode":"125009","country":"Россия"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.company.requisite.address.add
Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make: такой вызов вернет ошибку SDK JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(ApiVersion.v3).call.
import { ApiVersion, Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type RequisiteAddressAddResult = {
id: {
requisiteId: number
typeId: number
}
}
try {
const response = await $b24.getHttpClient(ApiVersion.v3).call<RequisiteAddressAddResult>(
'crm.company.requisite.address.add',
{
fields: {
requisiteId: 549,
typeId: 6,
address1: 'ул. Тверская, д. 1',
city: 'Москва',
postalCode: '125009',
country: 'Россия',
},
},
Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Address created:', result.id)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(B24Js.ApiVersion.v3).call.
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addRequisiteAddress() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
'crm.company.requisite.address.add',
{
fields: {
requisiteId: 549,
typeId: 6,
address1: 'ул. Тверская, д. 1',
city: 'Москва',
postalCode: '125009',
country: 'Россия',
},
},
B24Js.Text.getUuidRfc4122()
)
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Address created:', result.id)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addRequisiteAddress)
</script>
У методов CRM нет готовых оберток в b24pysdk, и SDK отправляет в REST 3.0 только методы из списка Config().api_v3_methods. Добавьте метод в этот список и вызовите его через bitrix_token.call_method с prefer_version=3.
from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError
method = "crm.company.requisite.address.add"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})
try:
response = bitrix_token.call_method(
api_method=method,
params={
"fields": {
"requisiteId": 549,
"typeId": 6,
"address1": "ул. Тверская, д. 1",
"city": "Москва",
"postalCode": "125009",
"country": "Россия",
},
},
prefer_version=3,
)
result = response["result"]
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"code: {error.code}",
f"message: {error.error.message}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
try {
$response = $b24Service
->core
->call(
'crm.company.requisite.address.add',
[
'fields' => [
'requisiteId' => 549,
'typeId' => 6,
'address1' => 'ул. Тверская, д. 1',
'city' => 'Москва',
'postalCode' => '125009',
'country' => 'Россия',
],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
BX24.callMethod(
'crm.company.requisite.address.add',
{
fields: {
requisiteId: 549,
typeId: 6,
address1: 'ул. Тверская, д. 1',
city: 'Москва',
postalCode: '125009',
country: 'Россия',
},
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
require_once('crest.php');
$result = CRest::call(
'crm.company.requisite.address.add',
[
'fields' => [
'requisiteId' => 549,
'typeId' => 6,
'address1' => 'ул. Тверская, д. 1',
'city' => 'Москва',
'postalCode' => '125009',
'country' => 'Россия',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.company.requisite.address.add", b24.Params{
"fields": b24.Params{
"requisiteId": 549,
"typeId": 6,
"address1": "ул. Тверская, д. 1",
"city": "Москва",
"postalCode": "125009",
"country": "Россия",
},
})
if err != nil {
return fmt.Errorf("crm.company.requisite.address.add: %w", err)
}
var result struct {
ID struct {
RequisiteID int `json:"requisiteId"`
TypeID int `json:"typeId"`
} `json:"id"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(result.ID.RequisiteID, result.ID.TypeID)
Обработка ответа
HTTP-статус: 200
{
"result": {
"id": {
"requisiteId": 549,
"typeId": 6
}
},
"time": {
"start": 1793711900,
"finish": 1793711900.089311,
"duration": 0.08931088447570801,
"processing": 0,
"date_start": "2026-11-03T16:18:20+03:00",
"date_finish": "2026-11-03T16:18:20+03:00",
"operating_reset_at": 1793712480,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с данными ответа |
|
result.id |
Идентификатор адреса — объект с полями |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_ENTITYALREADYEXISTSEXCEPTION",
"message": "Запись с идентификатором 6 уже существует."
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Обязательное поле |
Передайте объект |
|
|
At least one address field must not be empty. |
Заполните хотя бы одно поле адреса |
|
|
Address type is not available in the current portal zone. |
Передайте тип адреса из списка типов |
|
|
The code of the country does not hold up against the country of the address. |
Передайте |
Ошибки валидации объекта
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не заполнено обязательное поле "requisiteId" |
Передайте |
|
|
Не заполнено обязательное поле "typeId" |
Передайте |
Адрес уже есть
Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYALREADYEXISTSEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Запись с идентификатором |
У реквизита уже есть адрес этого типа. Измените его методом crm.<тип>.requisite.address.update или выберите другой |
Реквизит не найден
Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Запись с ID = |
Реквизита нет, он принадлежит владельцу другого типа или у вас нет права на изменение владельца |
Ошибка неизвестного поля
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестное поле |
Проверьте имя поля по описанию полей адреса |
Метод не найден
Код ошибки: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP-статус 404
|
Поле |
Описание ошибки |
Как исправить |
|
|
Метод |
Проверьте имя метода: оно пишется в нижнем регистре, например |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |