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

Показать блок

POST /v1/pages/:pageId/blocks/:blockId/show

Делает скрытый блок снова видимым в черновике страницы, место блока на странице не меняется.

Параметры

Параметр Тип Обяз. Описание
ПараметрpageId (path) Типnumber Обяз.да ОписаниеID страницы. Список: GET /v1/pages
ПараметрblockId (path) Типnumber Обяз.да ОписаниеID блока из черновика страницы pageId. Список: GET /v1/pages/:pageId/blocks без параметра version. Для блока другой страницы, блока из корзины и ID из опубликованной версии ответ — 404
Параметрscope (query) Типstring Обяз.нет ОписаниеТип сайта: KNOWLEDGE — база знаний, GROUP — сайт рабочей группы, MAINPAGE — главная страница. Для страниц остальных сайтов параметр не передают

Тело не нужно: вызов принимает пустой запрос или {}. Любое поле в теле отклоняется с 400 INVALID_PARAMS.

Примеры

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

Terminal
curl -X POST "https://vibecode.bitrix24.tech/v1/pages/2417/blocks/29453/show" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

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

Terminal
curl -X POST "https://vibecode.bitrix24.tech/v1/pages/2417/blocks/29453/show" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

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

javascript
const response = await fetch("https://vibecode.bitrix24.tech/v1/pages/2417/blocks/29453/show", {
  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-приложение

javascript
const response = await fetch("https://vibecode.bitrix24.tech/v1/pages/2417/blocks/29453/show", {
  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.active Типboolean ОписаниеВидимость блока, прочитанная после записи. После этого вызова всегда true. ID блока и страницы в ответе нет

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

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

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

404 — запрос с blockId 29457, который принадлежит другой странице:

JSON
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Blocks not found on this page.",
    "blockIds": [
      29457
    ]
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеPath ids must be positive safe integers. — pageId или blockId не является положительным целым числом
HTTP400 КодINVALID_PARAMS ОписаниеBody must be a JSON object. — тело не является JSON-объектом
HTTP400 КодINVALID_PARAMS ОписаниеUnsupported body field. — в теле передано какое-либо поле
HTTP400 КодFST_ERR_CTP_EMPTY_JSON_BODY ОписаниеПередан заголовок Content-Type: application/json, а тело пустое. Пришлите тело {} либо уберите заголовок
HTTP400 КодINVALID_SCOPE Описаниеscope must be KNOWLEDGE, GROUP or MAINPAGE, or omitted. — scope не равен KNOWLEDGE, GROUP или MAINPAGE
HTTP404 КодENTITY_NOT_FOUND ОписаниеBlocks not found on this page. — блока нет в черновике страницы pageId: блок другой страницы, блок в корзине, удалённый блок, ID из опубликованной версии или страницы pageId нет. ID таких блоков перечислены в error.blockIds
HTTP404 КодENTITY_NOT_FOUND ОписаниеPage or block not found. — Битрикс24 не нашёл страницу или блок при записи
HTTP422 КодBITRIX_NO_EFFECT ОписаниеBitrix24 returned an invalid block descriptor; the action cannot be confirmed. — Битрикс24 вернул описание блока, которое не удалось разобрать
HTTP422 КодBITRIX_NO_EFFECT ОписаниеBitrix24 did not acknowledge the action. — Битрикс24 не подтвердил запись
HTTP422 КодBITRIX_NO_EFFECT ОписаниеBlock visibility could not be confirmed. — после записи видимость блока не совпала с запрошенной
HTTP422 КодBITRIX_ERROR ОписаниеБитрикс24 отклонил действие. Текст ошибки приходит от Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа landing
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч работает в режиме «только чтение», запрос отклонён до обращения к Битрикс24
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеУ пользователя Битрикс24, от имени которого выпущен ключ, нет прав на изменение страницы
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP401 КодINVALID_API_KEY ОписаниеКлюч в X-Api-Key не найден или отозван
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов
HTTP409 КодLANDING_MODULE_NOT_ENABLED ОписаниеМодуль «Сайты» недоступен на портале
HTTP409 КодPORTAL_ADDRESS_CHANGED ОписаниеКоробочный Битрикс24 переехал на новый адрес, а вебхук ключа выписан на прежний. Выпустите вебхук ключа заново
HTTP429 КодRATE_LIMITED ОписаниеПревышен лимит запросов к Битрикс24. Повторите запрос через 1-2 секунды
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 не ответил, ответил ошибкой сервера или прислал ответ больше 8 МиБ
HTTP503 КодBITRIX_TIMEOUT ОписаниеБитрикс24 не ответил за отведённое время

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

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

  • Повтор безопасен. Вызов для блока, который уже виден, отвечает 200 с тем же data.active.
  • Скрытый блок остаётся в списке блоков. В ответе GET /v1/pages/:pageId/blocks у него active: false.
  • Вызов меняет черновик страницы. Посетитель сайта увидит изменение после публикации страницы — POST /v1/pages/:id/publication, подробнее в разделе Страницы.

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