## Permanently delete selected blocks

`POST /v1/pages/:pageId/blocks/bulk-purge`

Deletes several blocks of one page with no way to restore them: they do not go to the page trash. If even one block is not on the page, none is deleted.

## Parameters

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

## Request fields (body)

| Field | Type | Required | Description |
|------|-----|:-----:|----------|
| `blockIds` | number[] | yes | IDs of blocks in the draft of page `pageId`, 1 to 50 items. List: [`GET /v1/pages/:pageId/blocks`](/docs/entities/pages/blocks/list). Repeated IDs are deleted once, but every array item counts toward the limit of 50 |
| `images` | object[] | no | Image bindings to blocks of this page that should be removed, up to 50 items |
| `images[].blockId` | number | yes | ID of the block on page `pageId` the image is bound to |
| `images[].fileId` | number | yes | ID of the image file. Returned in `data.fileId` on upload: [`POST /v1/pages/:pageId/blocks/:blockId/files`](/docs/entities/pages/block-files) |

## Examples

### curl — personal key

```bash
curl -X POST "https://vibecode.bitrix24.com/v1/pages/2417/blocks/bulk-purge" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"blockIds": [29479, 29481]}'
```

### curl — OAuth application

```bash
curl -X POST "https://vibecode.bitrix24.com/v1/pages/2417/blocks/bulk-purge" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"blockIds": [29479, 29481]}'
```

### JavaScript — personal key

```javascript
const response = await fetch("https://vibecode.bitrix24.com/v1/pages/2417/blocks/bulk-purge", {
  method: "POST",
  headers: {"X-Api-Key": "YOUR_API_KEY", "Content-Type": "application/json"},
  body: JSON.stringify({"blockIds": [29479, 29481]}),
})
const result = await response.json()
if (!response.ok) throw new Error(result.error.message)
console.log(result.data)
```

### JavaScript — OAuth application

```javascript
const response = await fetch("https://vibecode.bitrix24.com/v1/pages/2417/blocks/bulk-purge", {
  method: "POST",
  headers: {"X-Api-Key": "YOUR_APP_KEY", "Authorization": "Bearer USER_SESSION_TOKEN", "Content-Type": "application/json"},
  body: JSON.stringify({"blockIds": [29479, 29481]}),
})
const result = await response.json()
if (!response.ok) throw new Error(result.error.message)
console.log(result.data)
```

## Response fields

| Field | Type | Description |
|------|-----|----------|
| `success` | boolean | Always `true` on success |
| `data.pageId` | number | Page ID |
| `data.deletedBlockIds` | number[] | IDs of the deleted blocks, without repeats. After the write, none of them is on the page, confirmed by a second read |

## Response example

```json
{
  "success": true,
  "data": {
    "pageId": 2417,
    "deletedBlockIds": [
      29479,
      29481
    ]
  }
}
```

## Error response example

404 — a request `{"blockIds": [29451, 29457]}`, where block 29457 belongs to another page; no block is deleted:

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

## Errors

| HTTP | Code | Description |
|------|-----|----------|
| 400 | `MISSING_REQUIRED_FIELDS` | `blockIds must be a non-empty array.` — the body has no `blockIds`, it is not an array, or the array is empty |
| 400 | `BLOCK_PURGE_LIMIT` | `At most 50 blocks and 50 images per request.` — `blockIds` or `images` has more than 50 items. Repeated IDs count too |
| 400 | `INVALID_PARAMS` | `blockIds must contain positive safe integers.` — `blockIds` contains a value that is not a positive integer |
| 400 | `INVALID_PARAMS` | `images must be an array.` — `images` is not an array |
| 400 | `INVALID_PARAMS` | `Each image needs positive blockId and fileId.` — an `images` item has no `blockId` or `fileId`, their values are not positive integers, or the item has other fields |
| 400 | `INVALID_PARAMS` | `Path ids must be positive safe integers.` — `pageId` is not a positive integer |
| 400 | `INVALID_PARAMS` | `Body must be a JSON object.` — the body is not a JSON object |
| 400 | `INVALID_PARAMS` | `Unsupported body field.` — the body contains a field that is not in the Request fields (body) table |
| 400 | `FST_ERR_CTP_EMPTY_JSON_BODY` | The `Content-Type: application/json` header is sent with an empty body. Send a body with `blockIds` |
| 400 | `INVALID_SCOPE` | `scope must be KNOWLEDGE, GROUP or MAINPAGE, or omitted.` — `scope` is not `KNOWLEDGE`, `GROUP` or `MAINPAGE` |
| 404 | `ENTITY_NOT_FOUND` | `Blocks not found on this page.` — the block is not in the draft of page `pageId`: it belongs to another page, is in the trash, was deleted, the ID comes from the published version, or page `pageId` does not exist. The same applies to a block from `images[].blockId`. The IDs of such blocks are listed in `error.blockIds` |
| 404 | `ENTITY_NOT_FOUND` | `Page or block not found.` — Bitrix24 did not find the page or block during the deletion |
| 422 | `BITRIX_NO_EFFECT` | `Bitrix24 returned an invalid block descriptor; the action cannot be confirmed.` — Bitrix24 returned a block descriptor that could not be parsed |
| 422 | `BITRIX_NO_EFFECT` | `Bitrix24 did not acknowledge the action.` — Bitrix24 did not confirm the deletion |
| 422 | `BITRIX_NO_EFFECT` | `Some blocks survived permanent deletion; do not blindly retry.` — after the deletion, some blocks are still on the page. Their IDs are in `error.blockIds` |
| 422 | `BITRIX_ERROR` | Bitrix24 rejected the action. The error text comes from Bitrix24 |
| 403 | `SCOPE_DENIED` | The API key does not have the `landing` scope |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is read-only. The request is rejected before Bitrix24 is called |
| 403 | `BITRIX_ACCESS_DENIED` | The Bitrix24 user the key is issued for has no permission to edit the page |
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |
| 401 | `INVALID_API_KEY` | The key in `X-Api-Key` is not found or has been revoked |
| 401 | `TOKEN_MISSING` | The API key has no configured tokens |
| 409 | `LANDING_MODULE_NOT_ENABLED` | The Sites module is not available on the Bitrix24 account |
| 409 | `PORTAL_ADDRESS_CHANGED` | A self-hosted Bitrix24 moved to a new address, but the key's webhook was issued for the old one. Reissue the key's webhook |
| 429 | `RATE_LIMITED` | The Bitrix24 request limit is exceeded. Retry the request in 1-2 seconds |
| 502 | `BITRIX_UNAVAILABLE` | Bitrix24 did not respond, returned a server error, or sent a response larger than 8 MiB |
| 503 | `BITRIX_TIMEOUT` | Bitrix24 did not respond in time |

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

## Known specifics

- **Image unbinding is not confirmed.** Bitrix24 does not report the result of unbinding `images`: the response is `200` even when the block has no file with that `fileId`.
- **Partial deletion.** On `422` with an `error.blockIds` list, the other blocks from the request are already deleted. Retry the call only for `error.blockIds`.
- **Retry after a lost response.** If the blocks are already deleted, repeating the same request returns `404`, lists the deleted blocks in `error.blockIds` and leaves the other blocks untouched. Remove those IDs from `blockIds` and call again.
- **The call changes the page draft.** Site visitors see the change after the page is published with `POST /v1/pages/:id/publication`. See [Pages](/docs/entities/pages) for details.

## See also

- [Permanently delete a block](/docs/entities/pages/blocks/purge)
- [Delete a block](/docs/entities/pages/blocks/delete)
- [Upload an image to a block](/docs/entities/pages/block-files)
- [List page blocks](/docs/entities/pages/blocks/list)
- [Pages](/docs/entities/pages)
- [Errors](/docs/errors)