## Create folder

`POST /v1/sites/:id/folders`

Creates a folder on a site. A folder groups pages: its symbolic code becomes a segment of their URL.

## Parameters

| Parameter | Type | Required | Description |
|----------|-----|:-----:|---------|
| `id` (path) | number | yes | Site identifier — a positive integer. List: [`GET /v1/sites`](/docs/entities/sites/list) |
| `scope` (query) | string | no | Internal landing scope: `KNOWLEDGE` / `GROUP` / `MAINPAGE`. Specify it if the site belongs to the corresponding scope. Otherwise `404 ENTITY_NOT_FOUND` is returned |

## Request fields (body)

| Field | Type | Required | Description |
|------|-----|:-----:|---------|
| `title` | string | yes | Folder name, a non-empty string |
| `code` | string | no | Folder symbolic code — the URL segment of its pages. If omitted, it is generated from `title`: `Docs test catalog` → `docstestcatalog` |
| `parentId` | number \| null | no | Identifier of a parent folder of this site. List: [`GET /v1/sites/:id/folders`](/docs/entities/sites/folders/list). Omitted or `null` — the folder is created at the site root |
| `indexPageId` | number \| null | no | Identifier of the folder home page — a page of the same site. List: [`GET /v1/pages?filter[siteId]=:id`](/docs/entities/pages/list) |

## Examples

### curl — personal key

```bash
curl -X POST "https://vibecode.bitrix24.com/v1/sites/109/folders" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "Docs test catalog"}'
```

### curl — OAuth application

```bash
curl -X POST "https://vibecode.bitrix24.com/v1/sites/109/folders" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title": "Docs test catalog"}'
```

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/sites/109/folders', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ title: 'Docs test catalog' }),
})

const { success, data } = await res.json()
console.log('Folder ID:', data.id)
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/sites/109/folders', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ title: 'Docs test catalog' }),
})

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

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | `true` on success |
| `data.id` | number | Folder identifier |
| `data.parentId` | number \| null | Parent folder identifier. `null` — the folder is at the site root |
| `data.siteId` | number | Site identifier |
| `data.indexPageId` | number \| null | Identifier of the folder home page — a page from [`GET /v1/pages`](/docs/entities/pages/list). `null` when not assigned |
| `data.active` | boolean | Whether the folder is published |
| `data.deleted` | boolean | Whether the folder is in the trash |
| `data.title` | string | Folder name |
| `data.code` | string | Folder symbolic code — the URL segment of its pages |
| `data.createdById` | number \| null | Identifier of the user who created the folder. List: [`GET /v1/users`](/docs/entities/users/list) |
| `data.modifiedById` | number \| null | Identifier of the user who last modified the folder |
| `data.dateCreate` | string \| null | Creation date in ISO 8601 without a time zone, in the Bitrix24 account's local time, e.g. `2026-10-16T11:44:24` |
| `data.dateModify` | string \| null | Last modification date in the same format |

## Response example

201 — folder created:

```json
{
  "success": true,
  "data": {
    "id": 109,
    "parentId": null,
    "siteId": 109,
    "indexPageId": null,
    "active": false,
    "deleted": false,
    "title": "Docs test catalog",
    "code": "docstestcatalog",
    "createdById": 1317,
    "modifiedById": 1317,
    "dateCreate": "2026-10-16T11:44:24",
    "dateModify": "2026-10-16T11:44:24"
  }
}
```

## Error response example

400 — the name is missing:

```json
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FIELDS",
    "message": "title is required"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 400 | `MISSING_REQUIRED_FIELDS` | The request body is empty or not an object |
| 400 | `MISSING_REQUIRED_FIELDS` | `title` is missing |
| 400 | `READONLY_FIELD` | The body contains a read-only field: `id`, `siteId`, `active`, `deleted`, `createdById`, `modifiedById`, `dateCreate`, `dateModify` |
| 400 | `INVALID_PARAMS` | The body contains a field other than `title`, `code`, `parentId`, `indexPageId` |
| 400 | `INVALID_PARAMS` | `title` is empty, `title` or `code` is not a string, `parentId` or `indexPageId` is neither a positive integer nor `null` |
| 400 | `INVALID_PARAMS` | `id` is not a positive integer |
| 400 | `INVALID_SCOPE` | `scope` is not `KNOWLEDGE`, `GROUP` or `MAINPAGE` |
| 404 | `ENTITY_NOT_FOUND` | No site with this `id`, the site is not accessible to the key's user, or it belongs to a different `scope` |
| 404 | `ENTITY_NOT_FOUND` | The created folder is not found when read back |
| 409 | `LANDING_MODULE_NOT_ENABLED` | The Sites module is unavailable on this Bitrix24 account. Ask a Bitrix24 account administrator to enable it — until then a retry returns the same refusal |
| 422 | `BITRIX_ERROR` | Bitrix24 rejected the creation, for example `indexPageId` points to a page of another site. The reason is in `message` |
| 403 | `BITRIX_ACCESS_DENIED` | Bitrix24 denied access: the key's user is not an administrator, or the feature is unavailable on the Bitrix24 account |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | The API key is read-only |
| 403 | `SCOPE_DENIED` | The API key does not have the `landing` scope |
| 401 | `TOKEN_MISSING` | The API key has no configured tokens |
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |

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

## Known specifics

- **A new folder is not published.** The response has `active: false`. Publish it with [`POST /v1/sites/:id/folders/:folderId/publication`](/docs/entities/sites/folders/publication) — its parent folders are published along with it.

## See also

- [List site folders](/docs/entities/sites/folders/list)
- [Update folder](/docs/entities/sites/folders/update)
- [Publish folder](/docs/entities/sites/folders/publication)