Снять с публикации

POST /v1/apps/:id/unpublish

Переводит опубликованное приложение в UNPUBLISHED и отвязывает места встраивания от портала.

Параметры

Параметр Тип Обяз. Описание
id (path) string да Идентификатор приложения в статусе PUBLISHED. Список: GET /v1/apps

Тело запроса не требуется — пустое тело допустимо.

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/apps/YOUR_APP_ID/unpublish" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/apps/YOUR_APP_ID/unpublish" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/apps/YOUR_APP_ID/unpublish',
  {
    method: 'POST',
    headers: { 'X-Api-Key': 'YOUR_API_KEY' },
  }
)
const body = await res.json()
if (!body.success) throw new Error(body.error.code)
console.log(body.data.placements) // []

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

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/apps/YOUR_APP_ID/unpublish',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  }
)

Поля ответа

Поле Тип Описание
success boolean true при успешном снятии с публикации
data object Приложение после снятия — те же 15 полей, что отдаёт данные приложения
data.placements string[] Пустой массив — места встраивания отвязаны

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

Поле data повторяет объект приложения с пустым массивом placements:

JSON 
{
  "success": true,
  "data": {
    "id": "33c4d5e6-f7a8-49b0-1234-5c6d7e8f9012",
    "title": "Дашборд продаж",
    "description": null,
    "scopes": ["crm", "user", "placement"],
    "handlerUrl": "https://vibecode.bitrix24.tech/v1/bitrix-handler",
    "appUrl": "https://app-abc12345.vibecode.bitrix24.tech",
    "redirectUris": [
      "https://vibecode.bitrix24.tech/oauth/complete",
      "http://localhost"
    ],
    "bitrixClientId": "local.7c3d4e5f6a7b80.55556666",
    "prefix": "vibe_app_local_7c3",
    "suffix": "6666",
    "authorId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "portalId": "8b1f0e2a-3c4d-5e6f-7a8b-9c0d1e2f3a4b",
    "createdAt": "2026-06-24T09:12:45.781Z",
    "updatedAt": "2026-06-24T09:12:45.781Z",
    "placements": []
  }
}

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

404 — приложение не опубликовано:

JSON 
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Published app not found"
  }
}

Ошибки

HTTP Код Описание
404 NOT_FOUND Приложение не существует, принадлежит другому порталу или не находится в статусе PUBLISHED
403 FORBIDDEN Запрос не от автора приложения и не от администратора портала

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

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

  • Возврат в UNPUBLISHED, а не в PRIVATE. Метаданные каталога — название, описание, иконка — сохраняются, поэтому повторная публикация с пустым телом восстанавливает приложение без повторного заполнения.
  • Отвязка мест встраивания не блокирует снятие. Отвязка идёт без ожидания результата по каждому коду. Сбой отвязки отдельного места встраивания не прерывает операцию — приложение переходит в UNPUBLISHED, а placements становится пустым.

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