Для AI-агентов: markdown этой страницы — /docs-content/infra/servers/b24-catalog-hide.md индекс документации — /llms.txt
Убрать приложение из Битрикс24
POST /v1/infra/servers/:id/b24-catalog/hide
Скрывает приложение от сотрудников в каталоге Битрикс24 и удаляет чат приложения вместе с историей. Доступ к приложению и его ссылки сохраняются.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
Параметрid (path) |
Типstring (UUID) | Обяз.да | ОписаниеID сервера из списка серверов. Сервер должен управляться API-ключом запроса |
Тело запроса может быть пустым или {}. Неизвестные поля игнорируются.
Примеры
curl — личный ключ
curl -X POST -H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" -d '{}' \
https://vibecode.bitrix24.tech/v1/infra/servers/SERVER_ID/b24-catalog/hide
curl — OAuth-приложение
curl -X POST -H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN" \
-H "Content-Type: application/json" -d '{}' \
https://vibecode.bitrix24.tech/v1/infra/servers/SERVER_ID/b24-catalog/hide
JavaScript — личный ключ
const res = await fetch(
`https://vibecode.bitrix24.tech/v1/infra/servers/${serverId}/b24-catalog/hide`,
{
method: 'POST',
headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
body: '{}',
}
)
const body = await res.json()
if (!body.success) throw new Error(body.error.code)
console.log(body.data.showInBitrix24, body.data.queued)
JavaScript — OAuth-приложение
const res = await fetch(
`https://vibecode.bitrix24.tech/v1/infra/servers/${serverId}/b24-catalog/hide`,
{
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
'Content-Type': 'application/json',
},
body: '{}',
}
)
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | Описаниеtrue, когда выбор сохранён |
Полеdata.queued |
Типboolean | Описаниеtrue, если карточка существует и её удаление поставлено в очередь. false, если карточки нет |
Полеdata.showInBitrix24 |
Типstring | ОписаниеСохранённый выбор. Всегда NO |
Пример ответа
У карточки поставлено удаление:
{
"success": true,
"data": {
"queued": true,
"showInBitrix24": "NO"
}
}
Пример ответа при ошибке
404 — сервер не найден или управляется другим API-ключом:
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Server not found"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP404 | КодNOT_FOUND |
ОписаниеСервер отсутствует, удалён или управляется другим API-ключом |
| HTTP404 | КодNOT_FOUND |
ОписаниеСервер удалили до сохранения выбора |
| HTTP401 | КодMISSING_API_KEY |
ОписаниеНе передан заголовок X-Api-Key |
| HTTP401 | КодINVALID_API_KEY |
ОписаниеКлюч не опознан |
| HTTP403 | КодINFRA_FORBIDDEN_FOR_COWORK_KEY |
ОписаниеКлюч Cowork/Code не разрешает изменяющие операции. Используйте проектный ключ для деплоя |
| HTTP403 | КодWRITE_BLOCKED_READONLY_KEY |
ОписаниеУ ключа режим «только чтение», а скрытие карточки — операция записи. Переключите ключ на чтение и запись, порядок — Режим доступа |
| HTTP429 | КодRATE_LIMITED |
ОписаниеПревышен лимит запросов. Повторите запрос после паузы из заголовка Retry-After |
Полный список общих ошибок API — Ошибки.
Известные особенности
- Карточка удаляется в фоне. Готовность проверяйте через состояние сервера:
b24CatalogSync.itemIdсталnull, аpendingOpперестал бытьDELETE. - Скрыть можно и до создания карточки. Ожидающая публикация отменяется, выбор становится
NO. Следующие деплои этот выбор сохраняют и карточку не создают. - Повторная публикация создаёт новый чат. После удаления покажите приложение снова, если оно нужно сотрудникам. Новый чат будет пустым, прежняя история не восстанавливается. Пока удаление ожидает выполнения, публикация отвечает
409 CATALOG_DELETE_PENDINGи выбор остаётсяNO. - Повторный вызов сохраняет выбор. Если карточки уже нет, метод возвращает
queued: falseиshowInBitrix24: "NO".