Для AI-агентов: markdown этой страницы — /docs-content/entities/pages/trash.md индекс документации — /llms.txt
В корзину
POST /v1/pages/:id/trash
Переносит страницу в корзину и снимает с публикации.
Требуется скоуп landing.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
Параметрid (path) |
Типnumber | Обяз.да | ОписаниеID страницы. Список: GET /v1/pages |
Параметрscope (query) |
Типstring | Обяз.нет | ОписаниеТип сайта: KNOWLEDGE — база знаний, GROUP — сайт рабочей группы, MAINPAGE — главная страница. Для страниц остальных сайтов параметр не передают |
Тело пустое или {}.
Примеры
curl — личный ключ
curl -X POST "https://vibecode.bitrix24.tech/v1/pages/2427/trash" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'
curl — OAuth-приложение
curl -X POST "https://vibecode.bitrix24.tech/v1/pages/2427/trash" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'
JavaScript — личный ключ
const response = await fetch("https://vibecode.bitrix24.tech/v1/pages/2427/trash", {
method: "POST",
headers: {"X-Api-Key": "YOUR_API_KEY", "Content-Type": "application/json"},
body: JSON.stringify({}),
})
const result = await response.json()
if (!response.ok) throw new Error(result.error.message)
console.log(result.data)
JavaScript — OAuth-приложение
const response = await fetch("https://vibecode.bitrix24.tech/v1/pages/2427/trash", {
method: "POST",
headers: {"X-Api-Key": "YOUR_APP_KEY", "Authorization": "Bearer USER_SESSION_TOKEN", "Content-Type": "application/json"},
body: JSON.stringify({}),
})
const result = await response.json()
if (!response.ok) throw new Error(result.error.message)
console.log(result.data)
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | ОписаниеВсегда true при успехе |
Полеdata |
Типobject | ОписаниеСтраница после действия |
Полеdata.id |
Типnumber | ОписаниеID страницы |
Полеdata.siteId |
Типnumber | ОписаниеID сайта страницы |
Полеdata.folderId |
Типnumber | null | ОписаниеID папки. null — страница в корне сайта |
Полеdata.title |
Типstring | ОписаниеНазвание страницы |
Полеdata.code |
Типstring | ОписаниеКод страницы в адресе |
Полеdata.active |
Типboolean | ОписаниеОпубликована ли страница |
Полеdata.deleted |
Типstring | ОписаниеY — страница в корзине, N — нет |
Пример ответа
{
"success": true,
"data": {
"id": 2427,
"siteId": 3,
"folderId": null,
"title": "Пустая страница",
"code": "pustayastranitsa_ujaa",
"active": false,
"deleted": "Y"
}
}
Пример ответа при ошибке
404 — страницы с таким id нет:
{
"success": false,
"error": {
"code": "ENTITY_NOT_FOUND",
"message": "Page not found."
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP404 | КодENTITY_NOT_FOUND |
ОписаниеPage not found. — страницы с таким id нет |
| HTTP404 | КодENTITY_NOT_FOUND |
ОписаниеPage or folder not found. — Битрикс24 не нашёл страницу или папку при выполнении действия |
| HTTP400 | КодINVALID_PAGE_ID |
Описаниеid must be a positive safe integer. — id не является положительным целым числом |
| HTTP400 | КодINVALID_PARAMS |
ОписаниеBody must be a JSON object. — тело не является JSON-объектом |
| HTTP400 | КодINVALID_PARAMS |
ОписаниеBody contains a field this operation does not accept. — в теле передано поле, а тело должно быть пустым или {} |
| HTTP400 | КодINVALID_SCOPE |
Описаниеscope must be KNOWLEDGE, GROUP or MAINPAGE, or omitted. — scope не равен KNOWLEDGE, GROUP или MAINPAGE |
| HTTP422 | КодBITRIX_NO_EFFECT |
ОписаниеBitrix24 did not confirm the page action. — Битрикс24 не подтвердил действие |
| HTTP422 | КодBITRIX_NO_EFFECT |
ОписаниеBitrix24 did not return the page after the action. — после действия страница не прочиталась |
| HTTP422 | КодBITRIX_NO_EFFECT |
ОписаниеBitrix24 did not persist the requested page state. — страница после действия не в корзине |
| HTTP422 | КодBITRIX_ERROR |
ОписаниеБитрикс24 отклонил действие, например для включаемой области. Текст ошибки приходит от Битрикс24 |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеAPI-ключ не имеет скоупа landing |
| HTTP403 | КодBITRIX_ACCESS_DENIED |
ОписаниеУ пользователя Битрикс24, от имени которого выпущен ключ, нет прав на действие со страницей |
| HTTP403 | КодWRITE_BLOCKED_READONLY_KEY |
ОписаниеКлюч работает в режиме «только чтение», запрос отклонён до обращения к Битрикс24 |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеAPI-ключ не имеет настроенных токенов |
| HTTP401 | КодMISSING_API_KEY |
ОписаниеНе передан заголовок X-Api-Key |
| HTTP401 | КодINVALID_API_KEY |
ОписаниеКлюч в X-Api-Key не найден или отозван |
| HTTP409 | КодPORTAL_ADDRESS_CHANGED |
ОписаниеКоробочный Битрикс24 переехал на новый адрес, а вебхук ключа выписан на прежний. Выпустите вебхук ключа заново |
| HTTP429 | КодRATE_LIMITED |
ОписаниеПревышен лимит запросов к Битрикс24. Повторите запрос через 1-2 секунды |
| HTTP502 | КодBITRIX_UNAVAILABLE |
ОписаниеБитрикс24 не ответил или ответил ошибкой сервера |
| HTTP503 | КодBITRIX_TIMEOUT |
ОписаниеБитрикс24 не ответил за отведённое время |
Полный список общих ошибок API — Ошибки.
Известные особенности
- Повторный вызов не возвращает ошибку. Для страницы, которая уже в корзине, ответ —
200с её текущим состоянием.