## Permanently delete a block

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

Deletes a block from the page with no way to restore it: the block does not go to the page trash.

## Parameters

| Parameter | Type | Required | Description |
|----------|-----|:-----:|----------|
| `pageId` (path) | number | yes | Page ID. List: [`GET /v1/pages`](/docs/entities/pages/list) |
| `blockId` (path) | number | yes | ID of a block in the draft of page `pageId`. List: [`GET /v1/pages/:pageId/blocks`](/docs/entities/pages/blocks/list) without the `version` parameter. A block from another page, a block in the trash, or an ID from the published version returns `404` |
| `scope` (query) | string | no | Site type: `KNOWLEDGE` — knowledge base, `GROUP` — workgroup site, `MAINPAGE` — main page. Omit the parameter for pages of other sites |

No body is needed: the call accepts an empty request or `{}`. Any field in the body is rejected with `400 INVALID_PARAMS`.

## Examples

### curl — personal key

```bash
curl -X POST "https://vibecode.bitrix24.com/v1/pages/2419/blocks/29461/purge" \
  -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/2419/blocks/29461/purge" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### JavaScript — personal key

```javascript
const response = await fetch("https://vibecode.bitrix24.com/v1/pages/2419/blocks/29461/purge", {
  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 application

```javascript
const response = await fetch("https://vibecode.bitrix24.com/v1/pages/2419/blocks/29461/purge", {
  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)
```

## Response fields

| Field | Type | Description |
|------|-----|----------|
| `success` | boolean | Always `true` on success |
| `data.pageId` | number | Page ID |
| `data.deletedBlockIds` | number[] | ID of the deleted block. After the write, the block is no longer on the page, confirmed by a second read |

## Response example

```json
{
  "success": true,
  "data": {
    "pageId": 2419,
    "deletedBlockIds": [
      29461
    ]
  }
}
```

## Error response example

404 — the block is already deleted:

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

## Errors

| HTTP | Code | Description |
|------|-----|----------|
| 400 | `INVALID_PARAMS` | `Path ids must be positive safe integers.` — `pageId` or `blockId` 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 |
| 400 | `FST_ERR_CTP_EMPTY_JSON_BODY` | The `Content-Type: application/json` header is sent with an empty body. Send a `{}` body or drop the header |
| 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 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, the block is still on the page. Its ID is 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

- **Deletion with a way back is a separate method.** [`DELETE /v1/pages/:pageId/blocks/:blockId`](/docs/entities/pages/blocks/delete) moves the block to the page trash, from which it can be restored.
- **A failure after the write does not cancel the deletion.** Responses `422 BITRIX_NO_EFFECT`, `429`, `502` and `503` do not mean that the block is still there. Check whether the block is in [`GET /v1/pages/:pageId/blocks`](/docs/entities/pages/blocks/list): a retry for a deleted block returns `404`.
- **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 selected blocks](/docs/entities/pages/blocks/bulk-purge)
- [Delete a block](/docs/entities/pages/blocks/delete)
- [List page blocks](/docs/entities/pages/blocks/list)
- [Pages](/docs/entities/pages)
- [Errors](/docs/errors)