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

Опубликовать приложение

POST /v1/apps/:id/publish

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

Параметры

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

Поля запроса (body)

Тело необязательное. При пустом теле берутся значения из записи приложения — это основной сценарий повторной публикации без изменений. Если передаёте тело, добавьте заголовок Content-Type: application/json — без него запрос с телом вернёт 413 PAYLOAD_TOO_LARGE.

Поле	Тип	Обяз.	Описание
`catalogTitle`	string	нет	Название в каталоге портала. Если не передано — текущее значение приложения
`catalogDescription`	string	нет	Описание в каталоге
`catalogIcon`	string	нет	Код иконки в каталоге
`appUrl`	string	нет	Адрес приложения: сервер Black Hole, контейнер в галактике или внешний https-адрес. Если не передан — текущий `appUrl` приложения
`placements`	string[]	нет	Коды мест встраивания. Список допустимых кодов — Доступные места. Если не передан — текущий набор приложения
`sourceVersionId`	string	нет	Конкретный снапшот исходников для публикации, формат `v<номер>`. Применимо при включённом хранилище исходников
`sourceServerId`	string	нет	Сервер, исходники которого публикуются, — идентификатор из `POST /v1/infra/servers/:id/deploy`. Нужен, когда исходники сохранил автосейв деплоя на сервере, который не принадлежит OAuth-ключу этого приложения: такой снапшот хранится у сервера, а не у приложения. Тот же смысл у заголовка `X-Source-Server`. Платформа сервер не подбирает — без этого поля проверка ищет снапшот приложения. Применимо при включённом хранилище исходников

Примеры

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

Terminal

curl -X POST "https://vibecode.bitrix24.tech/v1/apps/YOUR_APP_ID/publish" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "placements": ["CRM_DEAL_DETAIL_TAB"] }'

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

Terminal

curl -X POST "https://vibecode.bitrix24.tech/v1/apps/YOUR_APP_ID/publish" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "placements": ["CRM_DEAL_DETAIL_TAB"] }'

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

javascript

const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/apps/YOUR_APP_ID/publish',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ placements: ['CRM_DEAL_DETAIL_TAB'] }),
  }
)
const body = await res.json()
if (!body.success) throw new Error(body.error.code)
// body.warnings — массив, если часть мест встраивания не привязалась
console.log(body.data.placements)

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

javascript

const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/apps/YOUR_APP_ID/publish',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ placements: ['CRM_DEAL_DETAIL_TAB'] }),
  }
)

Поля ответа

Поле	Тип	Описание
`success`	boolean	`true` при успешной публикации
`data`	object	Приложение после публикации — те же 17 полей, что отдаёт данные приложения
`data.placements`	string[]	Привязанные места встраивания
`data.catalogStatus`	string	После публикации — `PUBLISHED`
`data.publishedAt`	string \| null	Дата публикации, ISO 8601
`warnings`	string[]	Присутствует, если часть мест встраивания не удалось привязать (перечисляет коды); если переданный `sourceServerId` не был использован, потому что хранилище исходников для портала отключено; или если опубликованная версия сервера осталась без бессрочного хранения — тогда строка несёт готовый `PATCH`, которым её можно пометить

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

Поле 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-24T10:03:18.204Z",
    "placements": ["CRM_DEAL_DETAIL_TAB"],
    "catalogStatus": "PUBLISHED",
    "publishedAt": "2026-06-24T10:03:18.204Z"
  }
}

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

400 — у OAuth-ключа нет скоупа placement: