Удалить связь реквизита

DELETE /v1/requisite-links/:entityTypeId/:entityId

Удаляет привязку реквизита к сущности. После удаления реквизит и банковский реквизит остаются в системе — удаляется только связь между ними и сущностью-владельцем.

Параметры

Параметр Тип Обяз. Описание
entityTypeId (path) number да Тип владельца связи: 2 — сделка, 31 — счёт
entityId (path) number да ID сущности-владельца

Примеры

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

Terminal
curl -X DELETE "https://vibecode.bitrix24.tech/v1/requisite-links/2/3825" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal
curl -X DELETE "https://vibecode.bitrix24.tech/v1/requisite-links/2/3825" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/requisite-links/2/3825', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Удалена связь для entityId:', data.entityId)

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/requisite-links/2/3825', {
  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.entityTypeId number Тип сущности из пути запроса
data.entityId number ID сущности из пути запроса
data.unregistered boolean Всегда true при успехе

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

HTTP-статус: 200 OK

JSON
{
  "success": true,
  "data": {
    "entityTypeId": 2,
    "entityId": 3825,
    "unregistered": true
  }
}

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

400 — некорректный entityTypeId или entityId в пути:

JSON
{
  "success": false,
  "error": {
    "code": "INVALID_ANCHOR",
    "message": "Path requires entityTypeId and entityId — both positive integers (e.g. /v1/requisite-links/31/42)"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_ANCHOR entityTypeId или entityId в пути не являются положительными целыми числами
403 SCOPE_DENIED API-ключ не имеет скоупа crm. Требуемое сообщение: This endpoint requires 'crm' scope
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Идемпотентно. Удаление возвращает 200 {unregistered: true} даже если связи для пары (entityTypeId, entityId) не существовало — повторный вызов безопасен, отдельной ошибки «не найдено» нет.

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