## Publish a block

`POST /v1/pages/:pageId/blocks/:blockId/publication`

Publishes a single block of a site page by its ID.

To publish the whole page, use `POST /v1/pages/:id/publication`; the page publishing flow is described in [Pages](/docs/entities/pages).

## Parameters

| Parameter | Type | Required | Description |
|----------|-----|:-----:|----------|
| `pageId` (path) | number | yes | Page ID. List: [`GET /v1/pages`](/docs/entities/pages/list) |
| `blockId` (path) | number | yes | Block ID on this page. List: [`GET /v1/pages/:pageId/blocks`](/docs/entities/pages/blocks/list) |
| `scope` (query) | string | no | Site scope: `KNOWLEDGE` — knowledge base, `GROUP` — workgroup pages, `MAINPAGE` — main pages. Omit for pages of all other sites |

Send no body or an empty object `{}`.

## Examples

### curl — personal key

```bash
curl -X POST "https://vibecode.bitrix24.com/v1/pages/42/blocks/7/publication" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### curl — OAuth application

```bash
curl -X POST "https://vibecode.bitrix24.com/v1/pages/42/blocks/7/publication" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/pages/42/blocks/7/publication', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})

const { success, data } = await res.json()
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/pages/42/blocks/7/publication', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})

const { success, data } = await res.json()
```

## Response fields

| Field | Type | Description |
|------|-----|----------|
| `success` | boolean | `true` on success |
| `data.id` | number | Block ID |
| `data.pageId` | number | Page ID |
| `data.anchor` | string | Block anchor. An automatic anchor has the form `b<id>`, for example `b7`. To change it: [`PUT /v1/pages/:pageId/blocks/:blockId/anchor`](/docs/entities/pages/block-anchor) |
| `data.content` | string | Full block HTML, re-read after publishing |
| `data.nodes` | object | Empty object. The block state is in `content` |
| `data.styles` | object | Empty object. The block state is in `content` |
| `data.attrs` | object | Empty object. The block state is in `content` |
| `data.cards` | object | Empty object. The block state is in `content` |
| `data.active` | boolean | Whether the block is active |

## Response example

The paragraph text in `content` is shortened with an ellipsis; the markup is unchanged.

```json
{
  "success": true,
  "data": {
    "id": 7,
    "pageId": 42,
    "anchor": "spring",
    "content": "<div id=\"block7\" data-id=\"7\" class=\"block-wrapper block-27-one-col-fix-title-and-text-2\"><section class=\"landing-block js-animation g-pt-30 g-pb-30\">\r\n\t<div class=\"landing-block-node-text-container container g-max-width-container\">\r\n\t\t<h3 class=\"landing-block-node-title g-color-red g-mb-20\">Spring sale</h3>\r\n\t\t<div class=\"landing-block-node-text js-animation g-mb-20 g-pb-1 g-color\">\r\n\t\t\tSed feugiat porttitor nunc, non dignissim ipsum vestibulum in...\r\n\t\t</div>\r\n\t</div>\r\n</section></div>",
    "nodes": {},
    "styles": {},
    "attrs": {},
    "cards": {},
    "active": true
  }
}
```

## Error response example

404 — the block is not on this page:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Page or block not found"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|----------|
| 400 | `INVALID_PARAMS` | `pageId` or `blockId` is not a positive integer |
| 400 | `INVALID_PARAMS` | The request body is not an empty object: it contains fields |
| 400 | `INVALID_SCOPE` | `scope` is not `KNOWLEDGE`, `GROUP` or `MAINPAGE` |
| 404 | `ENTITY_NOT_FOUND` | The page does not exist, the block does not exist, or the block belongs to another page |
| 404 | `ENTITY_NOT_FOUND` | The publication was accepted, but the block could not be re-read afterwards |
| 409 | `LANDING_MODULE_NOT_ENABLED` | The Sites module is not enabled on the Bitrix24 account |
| 409 | `PORTAL_ADDRESS_CHANGED` | The on-premise Bitrix24 moved to a new address, but the key's webhook was issued for the old one. Reissue the key's webhook |
| 422 | `BITRIX_ERROR` | Bitrix24 did not confirm the block publication |
| 403 | `SCOPE_DENIED` | The key lacks the `landing` scope |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is read-only. The request is rejected before reaching Bitrix24 |
| 401 | `TOKEN_MISSING` | The API key has no Bitrix24 access tokens |

Full list of common API errors — [Errors](/docs/errors).

## See also

- [Read block content](/docs/entities/pages/block-content)
- [List page blocks](/docs/entities/pages/blocks/list)
- [Set a block anchor](/docs/entities/pages/block-anchor)
- [Pages](/docs/entities/pages)
- [Errors](/docs/errors)