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

Включить лиды

POST /v1/leads/enable

Переключает весь портал Битрикс24 в классический режим CRM с лидами.

Метод требует обновления CRM после 26.2200.0. Номер выпущенной версии ещё не определён. Доступен не на всех порталах Битрикс24. Возможность должен включить администратор.

Внимание: режим CRM изменяется для всего портала, для всех пользователей. Нужны права администратора CRM, также действуют ограничения тарифа. Используйте ключ READWRITE со скоупом crm.

Поля запроса (body)

Параметров пути и запроса нет. Тело можно не передавать или передать пустой объект {}. Поля в теле не принимаются.

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/leads/enable" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/leads/enable" \
  -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/enable', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})
const result = await res.json()
console.log(result)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/leads/enable', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const result = await res.json()
console.log(result)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успехе
Полеdata.enabled Типboolean ОписаниеВключены ли лиды после выполнения действия

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

HTTP 200.

JSON 
{
  "success": true,
  "data": {
    "enabled": true
  }
}

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

400 — в теле передано поле:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "This action takes no body fields"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНеверный формат пути или тела запроса
HTTP400 КодUNKNOWN_FILTER_FIELD ОписаниеНеизвестный или повторяющийся параметр запроса
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеНедостаточно прав в Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеКлюч не имеет скоупа crm
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеЗапись запрещена ключу READONLY
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенного доступа к Битрикс24
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP422 КодMETHOD_NOT_YET_AVAILABLE ОписаниеВозможность не включена или метод недоступен на этом портале. error.release указывает обновление
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеПолучен некорректный ответ Битрикс24

Другие отказы Битрикс24 сохраняют HTTP-статус, код и сообщение с удалением учётных данных. Общие ошибки API — Ошибки.

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

После таймаута или обрыва соединения не повторяйте запрос вслепую: режим мог измениться. Сначала прочитайте GET /v1/crm-settings/mode и сопоставьте текущий режим с нужным результатом.

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