Удалить адрес

DELETE /v1/addresses/:typeId/:entityTypeId/:entityId

Удаляет адрес по трём значениям ключа: typeId, entityTypeId, entityId. Восстановить удалённый адрес через API нельзя — создавайте новый при необходимости.

Параметры

Параметр Тип Обяз. Описание
typeId (path) number да Тип адреса. Примеры: 1 — регистрационный, 8 — доставки, 9 — фактический, 11 — бенефициар
entityTypeId (path) number да Тип владельца: 8 — реквизит, 3 — контакт, 4 — компания, 1 — лид
entityId (path) number да ID владельца адреса. Для реквизита — ID из GET /v1/requisites

Примеры

curl — личный ключ

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/addresses/11/8/1" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/addresses/11/8/1" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/addresses/11/8/1', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
if (success && data.deleted) {
  console.log('Адрес удалён')
}

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/addresses/11/8/1', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Подтверждение удаления с эхом ключа
data.typeId number Тип адреса из пути
data.entityTypeId number Тип владельца из пути
data.entityId number ID владельца из пути
data.deleted boolean Всегда true при успешном удалении

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "typeId": 11,
    "entityTypeId": 8,
    "entityId": 1,
    "deleted": true
  }
}

Пример ответа при ошибке

403 — нет скоупа crm:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_COMPOSITE_KEY Один или несколько параметров пути typeId, entityTypeId, entityId не являются положительными целыми числами
404 NOT_FOUND Адрес с таким составным ключом не найден
422 BITRIX_ERROR Битрикс24 отклонил удаление существующего адреса
403 SCOPE_DENIED Ключу не хватает скоупа crm. This endpoint requires 'crm' scope
401 TOKEN_MISSING Не передан X-Api-Key или ключ не имеет настроенных токенов

Полный список общих ошибок API — Ошибки.

Известные особенности

Ответ — 200 JSON, не 204. Удаление адреса возвращает 200 OK с JSON-телом, где data.deleted равно true, а не 204 No Content.

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

Адрес не найден — 404. Если адреса с таким составным ключом нет, эндпоинт возвращает 404 NOT_FOUND и не выполняет удаление.

Смотрите также