Отвязать

DELETE /v1/activities/:activityId/bindings

Снимает привязку дела к указанной CRM-сущности. В её таймлайне дело больше не отображается, но остаётся в таймлайнах остальных привязанных сущностей.

Параметры

Параметр Тип Обяз. Описание
activityId (path) number да ID дела. Список: GET /v1/activities
entityTypeId (query) number да Числовой код типа сущности:
1 — лид
2 — сделка
3 — контакт
4 — компания
7 — предложение
31 — счёт
≥128 — смарт-процесс, его код — в `GET /v1/smart-processes`
entityId (query) number да ID сущности, от которой отвязываем

entityTypeId и entityId можно передать как query-параметры или в теле запроса.

Примеры

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/activities/3631/bindings?entityTypeId=3&entityId=9" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/activities/3631/bindings?entityTypeId=3&entityId=9" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/activities/3631/bindings?entityTypeId=3&entityId=9', {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/activities/3631/bindings?entityTypeId=3&entityId=9', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.activityId number ID дела
data.entityTypeId number Числовой код типа отвязанной сущности
data.entityId number ID отвязанной сущности
data.deleted boolean Всегда true — подтверждение, что привязка снята

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

JSON 
{
  "success": true,
  "data": {
    "activityId": 3631,
    "entityTypeId": 3,
    "entityId": 9,
    "deleted": true
  }
}

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

422 — попытка снять единственную привязку:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Нельзя удалять единственную привязку дела к сущности"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS activityId, entityTypeId или entityId не положительное целое число
404 ENTITY_NOT_FOUND Дела с указанным activityId не существует
422 BITRIX_ERROR Попытка снять единственную оставшуюся привязку дела
403 SCOPE_DENIED Ключу не хватает скоупа crm
401 TOKEN_MISSING У ключа нет настроенных токенов

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

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

Нельзя снять последнюю привязку. Дело должно оставаться привязанным минимум к одной сущности — попытка отвязать единственную возвращает 422, привязка сохраняется.

Перенос дела на другую запись. Чтобы перенести дело, не нарушив запрет на снятие последней привязки, см. Переместить привязку — там описан безопасный порядок и перенос одним вызовом в пределах одного типа.

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