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

Метод в процессе раскатки — выходит в обновлении crm 26.2100.0. Доступен не на всех порталах Битрикс24. Если метод ещё не доступен, API вернёт 422 METHOD_NOT_YET_AVAILABLE.

Восстановить источник сквозной аналитики

POST /v1/crm-tracking/sources/:id/unarchive

POST /v1/crm-tracking/sources/by-code/:code/unarchive

Возвращает архивный источник сквозной аналитики в список активных источников.

Требуется скоуп crm, ключ READWRITE, включённый флаг crm-tracking-v3 и доступность метода на портале Битрикс24.

Параметры

Параметр Тип Обяз. По умолч. Описание
Параметрid (path) Типnumber Обяз.для пути по ID По умолч.— ОписаниеПоложительный целый ID из списка источников.
Параметрcode (path) Типstring Обяз.для пути по коду По умолч.— ОписаниеНепустой код встроенного источника из списка источников.

Используйте ровно один адрес: :id или by-code/:code. Параметры строки запроса не принимаются. Тело запроса отсутствует или равно {}. Поля в теле не принимаются.

Примеры

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

Terminal 
curl -i -X POST "https://vibecode.bitrix24.tech/v1/crm-tracking/sources/2/unarchive" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -i -X POST "https://vibecode.bitrix24.tech/v1/crm-tracking/sources/2/unarchive" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-tracking/sources/2/unarchive', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY'
  }
})
console.log(res.status === 204)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-tracking/sources/2/unarchive', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN'
  }
})
console.log(res.status === 204)

Ответ

При успехе — 204 No Content с пустым телом. Проверяйте HTTP-статус без разбора JSON.

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

http 
HTTP/1.1 204 No Content

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

400 — непустое тело запроса:

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

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНекорректный ID, пустой код или недопустимое тело запроса.
HTTP400 КодUNKNOWN_FILTER_FIELD ОписаниеПередан параметр строки запроса.
HTTP403 КодSCOPE_DENIED ОписаниеУ ключа нет скоупа crm.
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеРежим ключа запрещает изменение данных.
HTTP404 КодENTITY_NOT_FOUND ОписаниеИсточник с указанным ID не найден.
HTTP422 КодMETHOD_NOT_YET_AVAILABLE ОписаниеФлаг crm-tracking-v3 выключен или метод ещё не доступен на портале Битрикс24.
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеПолучен некорректный ответ Битрикс24.

Коды, статусы и текст остальных отказов Битрикс24 сохраняются. Общие ошибки — Ошибки.

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

Повторное восстановление уже активного источника ничего не меняет.

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