Для AI-агентов: markdown этой страницы — /docs-content/entities/leads/contacts-delete.md индекс документации — /llms.txt

Отвязать все контакты от лида

DELETE /v1/leads/:id/contacts

Отвязывает от лида все привязанные контакты одним вызовом, сами контакты остаются в CRM.

Чтобы потом вернуть связи, сохраните состав через GET /v1/leads/:id/contacts до отвязки и передайте его в PUT /v1/leads/:id/contacts.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типnumber Обяз.да ОписаниеID лида. Список: GET /v1/leads

Примеры

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

Terminal
curl -X DELETE "https://vibecode.bitrix24.tech/v1/leads/1001321/contacts" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal
curl -X DELETE "https://vibecode.bitrix24.tech/v1/leads/1001321/contacts" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

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

if (res.status === 204) {
  console.log('Все контакты отвязаны')
}

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

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

if (res.status === 204) {
  console.log('Все контакты отвязаны')
}

Ответ

При успешной отвязке возвращается HTTP-статус 204 No Content с пустым телом. Признак успеха — код ответа, а не содержимое.

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

HTTP/1.1 204 No Content

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

404 — лида с таким id нет:

JSON
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Элемент не найден"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS Описаниеid не является положительным целым числом
HTTP404 КодENTITY_NOT_FOUND ОписаниеЛида с таким id нет
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP401 КодTOKEN_MISSING ОписаниеК ключу не привязаны токены Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа crm
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч работает в режиме только чтения. Для отвязки нужен ключ с правом записи
HTTP429 КодRATE_LIMITED ОписаниеПревышен лимит запросов. Повторите после срока из заголовка Retry-After
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен. Повторите запрос позже

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

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

  • Повтор безопасен. Вызов для лида без контактов тоже отвечает 204, поэтому после потерянного ответа запрос можно повторить.

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