# uCoz API (uAPI) — Full Reference

> REST API for full management of websites hosted on the uCoz platform. Provides programmatic access to all site modules: content, users, e-commerce, design, templates, settings, security, and tools. Suitable for automation, integrations, and AI agents.

Documentation: https://api.ucoz.net/

This file is generated from the English OpenAPI specs (`en/*-openapi.yaml`) and lists **every** documented path, method, parameter, and request-body field.

## Authentication

All requests require a Bearer JWT token:

```
Authorization: Bearer <token>
```

Tokens are created in the site control panel under **Site → uAPI**. Pass the token in the `Authorization` header of every request.

## Base URL

```
https://{yoursite}/uapi
```

Example: `https://mysite.ucoz.ru/uapi`

All paths below are relative to this base URL. Prefer `application/x-www-form-urlencoded` for write bodies unless a method says otherwise.

> **For AI agents**: the [uCoz MCP server](https://api.ucoz.net/mcp.html) (`npx ucoz-mcp@latest`) is recommended for templates, whole-site design, menus, forms, modules, and FTP.

---

## Model Context Protocol (MCP)

Documentation: https://api.ucoz.net/mcp.html

Production-ready MCP server for AI agents (`npx ucoz-mcp@latest`). Ten tools: `templates_tool`, `tmaker_tool`, `content_tool`, `shop_tool`, `subscriptions_tool`, `users_tool`, `ftp_tool`, `modules_tool`, `skills_tool`, `docs_tool`. Everyday single-template edits use `templates_tool`; whole-site design publishing uses `tmaker_tool`.

Requires Node.js 18+.

### Setup

```json
{
  "mcpServers": {
    "ucoz-mcp": {
      "command": "npx",
      "args": ["-y", "ucoz-mcp@latest"],
      "env": {
        "UCOZ_API_TOKEN": "YOUR_UCOZ_API_TOKEN",
        "UCOZ_SITE_URL":  "https://your-site.ucoz.net/",
        "UCOZ_FTP_HOST":  "your-site.ucoz.net",
        "UCOZ_FTP_USER":  "your-ftp-login",
        "UCOZ_FTP_PASS":  "your-ftp-password"
      }
    }
  }
}
```

Add this config to:
- **Cursor**: Settings → Customize → MCPs → New MCP Server
- **Claude Desktop** (macOS): `~/Library/Application Support/Claude/claude_desktop_config.json`
- **Claude Desktop** (Windows): `%APPDATA%/Claude/claude_desktop_config.json`
- **Codex / Antigravity / other stdio clients**: command `npx`, args `-y ucoz-mcp@latest`, same env

**Token**: site control panel → Site → uAPI. For full MCP access, a key with Control Panel settings access is recommended (whole-site design, module install, FTP password changes, some subscription admin actions).
**FTP credentials**: site control panel → FTP (activation may take up to 15 minutes).
Optional: `UCOZ_WORKSPACE` — project root for skill installs.

### Tool: `templates_tool`

Single-template edits, backups, global blocks, menus, mail forms, pages. Auto-backup before save.

Key actions: `list_modules`, `get_variables`, `read_template`, `patch_template` (preferred for edits), `update_template` (full rewrite), `validate_template`, `list_backups`, `create_backup`, `delete_backup`, `restore_backup`, `gblock_create`, `gblock_delete`, `menu_*`, `mail_*`, `page_*`, `get_reference`, `get_guide`, `get_backup_guide`.

### Tool: `tmaker_tool`

Whole-site design / HTML frame (skeleton). Publishes one frame into all site templates. Requires Control Panel settings access.

Key actions: `skeleton_guide`, `skeleton_rules`, `designs_list` / `design_get`, `project_list` / `project_get`, `skeleton_validate`, `project_save`, `project_save_active`, `project_delete`, `skeleton_archive`, `skeleton_publish` (`confirm=true` required).

### Tool: `content_tool`

Content modules via `module` + `action`: news, blog, publ, board, photo, video, faq, dir, load, gb, stuff, forum, mchat, polls. Entry CRUD, categories, comments, forum sections/topics/posts.

### Tool: `shop_tool`

Online shop: categories, goods, images, variations (`variation_dict` → `variation_gen` with `var_*` fields), stock, basket, checkout, orders, balance.

### Tool: `subscriptions_tool`

Plans, user subscriptions, payments, access checks. Admin actions need Control Panel settings access.

### Tool: `users_tool`

Users, groups, ranks, profile fields: `list`/`get`/`add`/`register`/`update`/`delete`, `group_*`, `groups_rights`, `ranks`, `fields`, `chlogin`/`chgroup`/`chpass`.

### Tool: `ftp_tool`

FTP file ops + FTP password via uAPI. Params: `path`, `filepath` (read/write), `source`/`destination` (rename), `ftp_password` (set/change). Actions: `list`, `read`, `write`, `mkdir`, `delete`, `rename`, `upload`, `ftp_password_*`.

### Tool: `modules_tool`

Module install/uninstall, uAPI toggles, quarantine: `modules_list`, `module_status`, `module_install`, `module_uninstall`, `active_mods`, `module_enable_uapi`, `module_disable_uapi`, `quarantine_status`, `quarantine_unlock`.

### Tool: `skills_tool`

Official skill routing: `resolve`, `catalog`, `status`, `install`, `register_usage`.

### Tool: `docs_tool`

OpenAPI fallback on api.ucoz.net: `search`, `list`, `fetch_spec`.

---
## API modules covered

Generated from 27 OpenAPI files.

## Users Module

OpenAPI: https://api.ucoz.net/user-openapi.yaml

| Method | Path | Summary |
|---|---|---|
| `GET` | `/users` | Get user list |
| `POST` | `/users` | Add user |
| `PUT` | `/users` | Edit user |
| `DELETE` | `/users` | Delete user |
| `GET` | `/users/groups` | Get user groups |
| `POST` | `/users/groups` | Create user group |
| `PUT` | `/users/groups` | Update user group |
| `DELETE` | `/users/groups` | Delete user group |
| `GET` | `/users/groups/rights` | Get user group permissions |
| `GET` | `/users/groups/permissions` | Get user group permissions |
| `GET` | `/users/rank` | Get user ranks |
| `POST` | `/users/chlogin` | Change user login |
| `POST` | `/users/chgroup` | Change user group |
| `POST` | `/users/chpass` | Change user password |
| `GET` | `/users/fields` | Get module field settings |

### `GET` `/users` — Get user list

Get a list of all site users. The number of users per page depends on module settings.

**Parameters:**
- `page` (query, optional, integer): Page number
- `user` (query, optional, string): User nickname or email (to fetch a specific user)
- `user_id` (query, optional, integer): User ID (to fetch a specific user)

### `POST` `/users` — Add user

Register a new user

**Request body** (`application/x-www-form-urlencoded`):
- `user` (required, string): User nickname
- `password` (required, string): User password
- `email` (required, string): User email
- `name` (required, string): User full name
- `telegram` (optional, object): Telegram
- `whatsapp` (optional, object): WhatsApp
- `viber` (optional, object): Viber
- `discord` (optional, object): Discord
- `instagram` (optional, object): Instagram
- `fb` (optional, object): Facebook
- `city` (optional, object): City

### `PUT` `/users` — Edit user

Edit user information

**Parameters:**
- `user_id` (query, required, integer): User ID

**Request body** (`application/x-www-form-urlencoded`):
- `name` (optional, string): User full name
- `email` (optional, string): User email
- `home_page` (optional, string): Home page (website)
- `signature` (optional, string): User signature
- `icq` (optional, string): ICQ
- `options` (optional, string): User options (comma-separated)
- `telegram` (optional, object): Telegram
- `whatsapp` (optional, object): WhatsApp
- `viber` (optional, object): Viber
- `discord` (optional, object): Discord
- `instagram` (optional, object): Instagram
- `fb` (optional, object): Facebook
- `city` (optional, object): City

### `DELETE` `/users` — Delete user

**Parameters:**
- `user` (query, required, string): User nickname

### `GET` `/users/groups` — Get user groups

Get all user groups

### `POST` `/users/groups` — Create user group

Create a user group by providing its basic settings and access permissions. Use GET /users/groups/rights to retrieve all available permission codes.

**Request body** (`application/x-www-form-urlencoded`):
- `name` (required, string): Group name
- `icon` (optional, string): Group icon URL
- `regsel` (optional, integer enum[0, 1]): Whether the group can be selected during registration
- `comadd` (optional, integer enum[0, 1]): Permission to add comments
- `comedit` (optional, integer enum[0, 1]): Permission to edit comments
- `comdel` (optional, integer enum[0, 1]): Permission to delete comments
- `nwadd` (optional, integer enum[0, 1]): Permission to add entries in Site News
- `nwedit` (optional, integer enum[0, 1]): Permission to edit entries in Site News
- `nwdel` (optional, integer enum[0, 1]): Permission to delete entries in Site News
- `bladd` (optional, integer enum[0, 1]): Permission to add blog posts
- `bledit` (optional, integer enum[0, 1]): Permission to edit blog posts
- `bldel` (optional, integer enum[0, 1]): Permission to delete blog posts
- `ldadd` (optional, integer enum[0, 1]): Permission to add entries in File Catalog
- `ldedit` (optional, integer enum[0, 1]): Permission to edit entries in File Catalog
- `lddel` (optional, integer enum[0, 1]): Permission to delete entries in File Catalog
- `puadd` (optional, integer enum[0, 1]): Permission to add entries in Article Catalog
- `puedit` (optional, integer enum[0, 1]): Permission to edit entries in Article Catalog
- `pudel` (optional, integer enum[0, 1]): Permission to delete entries in Article Catalog

### `PUT` `/users/groups` — Update user group

Update the basic settings and access permissions of an existing group. Use GET /users/groups/rights to retrieve all available permission codes.

**Request body** (`application/x-www-form-urlencoded`):
- `id` (required, integer): Group ID
- `name` (required, string): New group name
- `icon` (optional, string): New group icon URL. An empty value clears the icon; omit the parameter to preserve it.
- `regsel` (optional, integer enum[0, 1]): Whether the group can be selected during registration. Omit the parameter to preserve its current value.
- `comadd` (optional, integer enum[0, 1]): Permission to add comments
- `comedit` (optional, integer enum[0, 1]): Permission to edit comments
- `comdel` (optional, integer enum[0, 1]): Permission to delete comments
- `nwadd` (optional, integer enum[0, 1]): Permission to add entries in Site News
- `nwedit` (optional, integer enum[0, 1]): Permission to edit entries in Site News
- `nwdel` (optional, integer enum[0, 1]): Permission to delete entries in Site News
- `bladd` (optional, integer enum[0, 1]): Permission to add blog posts
- `bledit` (optional, integer enum[0, 1]): Permission to edit blog posts
- `bldel` (optional, integer enum[0, 1]): Permission to delete blog posts
- `ldadd` (optional, integer enum[0, 1]): Permission to add entries in File Catalog
- `ldedit` (optional, integer enum[0, 1]): Permission to edit entries in File Catalog
- `lddel` (optional, integer enum[0, 1]): Permission to delete entries in File Catalog
- `puadd` (optional, integer enum[0, 1]): Permission to add entries in Article Catalog
- `puedit` (optional, integer enum[0, 1]): Permission to edit entries in Article Catalog
- `pudel` (optional, integer enum[0, 1]): Permission to delete entries in Article Catalog

### `DELETE` `/users/groups` — Delete user group

Delete a user group and move its members to the specified group.

**Parameters:**
- `id` (query, required, integer): ID of the group to delete — the group_id value returned by GET /users/groups
- `nid` (query, optional, integer): ID of the group to move members to — the group_id value returned by GET /users/groups

### `GET` `/users/groups/rights` — Get user group permissions

Get access permissions for all user groups

### `GET` `/users/groups/permissions` — Get user group permissions

Get a group configuration and the complete set of its available permissions in a format suitable for PUT /users/groups.

**Parameters:**
- `id` (query, required, integer): Group ID — the group_id value returned by GET /users/groups

### `GET` `/users/rank` — Get user ranks

Get all user ranks

### `POST` `/users/chlogin` — Change user login

Change the user login (nickname)

**Request body** (`application/x-www-form-urlencoded`):
- `user_id` (required, integer): User ID
- `login` (required, string): New login (nickname)

### `POST` `/users/chgroup` — Change user group

Change the user group

**Request body** (`application/x-www-form-urlencoded`):
- `user_id` (required, integer): User ID
- `gid` (required, integer): New group ID

### `POST` `/users/chpass` — Change user password

Change the user password

**Request body** (`application/x-www-form-urlencoded`):
- `user_id` (required, integer): User ID
- `password` (required, string): New password

### `GET` `/users/fields` — Get module field settings

Profile form settings in the control panel: available registration and profile edit fields (including `telegram`, `whatsapp`, `viber`, `discord`, `instagram`, `fb`, `city`, and others).

---
## Pages Module

OpenAPI: https://api.ucoz.net/pages-openapi.yaml

| Method | Path | Summary |
|---|---|---|
| `GET` | `/pages` | Get site pages |
| `POST` | `/pages` | Add page |
| `PUT` | `/pages` | Edit page |
| `DELETE` | `/pages/{id}` | Delete page |

### `GET` `/pages` — Get site pages

With the `id` parameter — returns full data for one page, including content, images, and parent page data. Without `id` — returns a paginated flat list of pages with full data for each. List items do not include a nested `parent` object — use a single request (`?id=`) to fetch parent page data. Supports `page` and `per_page`. Requires permission to view or edit site pages.

**Parameters:**
- `id` (query, optional, integer): Page ID. If set — one page is returned; if omitted — a list.
- `page` (query, optional, integer): Page number (list mode only, default 1)
- `per_page` (query, optional, integer): Items per page (list mode only, default 50, max 100)

### `POST` `/pages` — Add page

Create a new site page. Any omitted optional fields use default values. To upload images, use `Content-Type: multipart/form-data` — add fields `file1`, `file2`, … (binary parts). Without images, `application/x-www-form-urlencoded` is enough. `del_imgN` flags are usually not needed when adding a new page (no slots yet). Requires permission to add site pages.

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `name` (required, string): Page title
- `message` (required, string): Page content (HTML)
- `parent_id` (optional, integer): Parent page ID (0 — root page; default 0)
- `pending` (optional, integer enum[0, 1]): Status: 1 — pending activation, 0 — active
- `owntmpl` (optional, integer enum[0, 1]): Use custom template: 1 — yes, 0 — no
- `tmpl` (optional, string): Custom template content (send together with `owntmpl=1`). If a non-empty `tmpl` is sent with `owntmpl=1`, the template markup must include the `$POWERED_BY$` placeholder. Otherwise the API returns `code`: `VALIDATION_ERROR` and `num`: `2`.
- `ownurl` (optional, string): Page custom URL (SEO-friendly)
- `access_all` (optional, integer enum[0, 1]): Access for all groups: 1 — allowed, 0 — restricted (default 1)
- `access_group_ids` (optional, array): Group IDs allowed access (when access_all=0; repeat the parameter for each ID)
- `meta_title` (optional, string): Meta Title
- `meta_description` (optional, string): Meta Description
- `meta_keywords` (optional, string): Meta Keywords
- `other1` (optional, string): Additional field 1
- `other2` (optional, string): Additional field 2
- `other3` (optional, string): Additional field 3
- `other4` (optional, string): Additional field 4
- `other5` (optional, string): Additional field 5
- `del_img1` (optional, integer enum[0, 1]): 1 — remove image in slot 1; 0 or omit — do not remove via this flag
- `del_img2` (optional, integer enum[0, 1]): 1 — remove image in slot 2
- `del_img3` (optional, integer enum[0, 1]): 1 — remove image in slot 3 (use del_img4, del_img5, … up to site limit the same way)
- `file1` (optional, string(binary)): Embedded image in page content (when enabled in module settings; then `file2`, `file3`, … up to site limit).
- `file2` (optional, string(binary)): Image
- `file3` (optional, string(binary)): Image
- `images_title` (optional, array): Image captions — one value per `fileN` in upload order. Repeat the parameter: `images_title=First&images_title=Second&…`
- `images_alt` (optional, array): Image alt texts — one value per `fileN` in upload order. Repeat the parameter: `images_alt=Photo&images_alt=Second+photo&…`

### `PUT` `/pages` — Edit page

Edit an existing page. Uses **PATCH semantics**: fields omitted from the request keep their current database values. Exceptions: access groups (`access_all` / `access_group_ids`) and SEO meta fields (`meta_title`, `meta_description`, `meta_keywords`) — updated only when at least one related parameter is sent. **Images:** if `file1`…`fileN` are omitted — all attached images are kept unchanged (PATCH semantics). To upload or replace, use `Content-Type: multipart/form-data` and binary parts `file1`, `file2`, …. To remove an image in slot N, send `del_imgN=1` (in the same `multipart/form-data` or `application/x-www-form-urlencoded`). Requires permission to edit site pages.

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `id` (required, integer): ID of page being edited
- `name` (optional, string): Page title
- `message` (optional, string): Page content (HTML)
- `parent_id` (optional, integer): Parent page ID (0 — root). Omit the field to keep the current value.
- `pending` (optional, integer enum[0, 1]): Status: 1 — pending activation, 0 — active
- `owntmpl` (optional, integer enum[0, 1]): Use custom template: 1 — yes, 0 — no (0 removes the custom template)
- `tmpl` (optional, string): Custom template content (send together with `owntmpl=1`). If a non-empty `tmpl` is sent with `owntmpl=1`, the template markup must include the `$POWERED_BY$` placeholder. Otherwise the API returns `code`: `VALIDATION_ERROR` and `num`: `2`.
- `ownurl` (optional, string): Page custom URL (SEO-friendly). Omit the field to keep the current URL.
- `access_all` (optional, integer enum[0, 1]): Access for all groups: 1 — allowed, 0 — restricted
- `access_group_ids` (optional, array): Group IDs allowed access (when access_all=0; repeat for each ID). Omit both access_all and access_group_ids to keep current access rights.
- `meta_title` (optional, string): Meta Title
- `meta_description` (optional, string): Meta Description
- `meta_keywords` (optional, string): Meta Keywords
- `other1` (optional, string): Additional field 1
- `other2` (optional, string): Additional field 2
- `other3` (optional, string): Additional field 3
- `other4` (optional, string): Additional field 4
- `other5` (optional, string): Additional field 5
- `del_img1` (optional, integer enum[0, 1]): 1 — remove image in slot 1; 0 or omit — do not remove via this flag
- `del_img2` (optional, integer enum[0, 1]): 1 — remove image in slot 2
- `del_img3` (optional, integer enum[0, 1]): 1 — remove image in slot 3 (use del_img4, del_img5, … up to site limit the same way)
- `file1` (optional, string(binary)): Embedded image in page content (when enabled in module settings; then `file2`, `file3`, … up to site limit).
- `file2` (optional, string(binary)): Image
- `file3` (optional, string(binary)): Image
- `images_title` (optional, array): Image captions — one value per `fileN` in upload order. Repeat the parameter: `images_title=First&images_title=Second&…`
- `images_alt` (optional, array): Image alt texts — one value per `fileN` in upload order. Repeat the parameter: `images_alt=Photo&images_alt=Second+photo&…`

### `DELETE` `/pages/{id}` — Delete page

Delete a site page by ID. Prefer passing the ID in the path (`/pages/{id}`). Alternative with the same result: `DELETE /pages` with query parameter `id`. The site home page (ID = 1) cannot be deleted — an error is returned. Child pages remain in the system attached to the root (`pid` set to 0). Requires permission to delete site pages.

**Parameters:**
- `id` (path, required, integer): ID of page to delete

---
## News Module

OpenAPI: https://api.ucoz.net/news-openapi.yaml

| Method | Path | Summary |
|---|---|---|
| `GET` | `/news` | Get all module entries |
| `POST` | `/news` | Add entry |
| `PUT` | `/news` | Edit entry |
| `DELETE` | `/news/posts` | Delete entry |
| `POST` | `/news/tags` | Add/update entry tags |
| `GET` | `/news/category` | Get category list |
| `POST` | `/news/category` | Add category |
| `PUT` | `/news/category` | Edit category |
| `DELETE` | `/news/category` | Delete category |
| `GET` | `/news/comments` | Get entry comments |
| `POST` | `/news/comments` | Add comment |
| `PUT` | `/news/comments` | Edit comment |
| `DELETE` | `/news/comments` | Delete comment |
| `GET` | `/news/filter` | Get filter list |
| `POST` | `/news/filter` | Add filter |
| `PUT` | `/news/filter` | Update filter |
| `DELETE` | `/news/filter` | Delete filter |
| `GET` | `/news/fields` | Get module field settings |

### `GET` `/news` — Get all module entries

Get a list of all entries in the "Site news" module. The number of entries per page depends on module settings.

**Parameters:**
- `page` (query, optional, integer): Request page. Applies to list requests; ignored when requesting an entry by ID
- `per_page` (query, optional, integer): Entries per request (list page size), 100 at most
- `date` (query, optional, string): Filter by date as yyyy-mm-dd or yyyy
- `id` (query, optional, integer): ID of a specific entry
- `category` (query, optional, integer): Filter by category ID (non-existing category — `NOT_FOUND`)
- `user_id` (query, optional, integer): Filter by numeric ID of the entry author
- `pending` (query, optional, integer): Non-zero value — return only entries pending activation (premoderation)

### `POST` `/news` — Add entry

Add a new entry to the "Site news" module. Text fields can be sent in `application/x-www-form-urlencoded`. File fields (`cover`, `file1`…`fileN`, `file`) are sent only in `multipart/form-data` (text fields may go in the same request).

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `category` (required, integer | string): Category ID or a comma-separated list of IDs (`3` or `3,4`). A list works only when the module option "Allow an entry to belong to multiple categories" is enabled (`options_other_categories` / `other_categories` in `/setup`). The primary category is determined by the category order in the control panel, not by the order of IDs in the submitted list. Parameters `ocat`, `ocats`, `categories`, and `…
- `title` (required, string): Entry title. Up to 150 characters - error when exceeded
- `description` (optional, string): Short description. Up to 1030 characters (up to 10000 - for groups with the right to edit all entries)
- `message` (optional, string): Full description. The maximum length is limited by the site plan
- `description_type` (optional, string enum['plain', 'bb', 'html']): Short description text format: `plain` - plain text (default), `bb` - BB codes, `html` - HTML
- `message_type` (optional, string enum['plain', 'bb', 'html']): Full description text format: `plain` - plain text (default), `bb` - BB codes, `html` - HTML
- `comments` (optional, integer enum[1, 0]): Allow comments on the entry. Default - enabled. Legacy `yes`/`no` values are also supported
- `ontop` (optional, integer enum[1, 0]): Always show the entry at the top. Default - disabled. Legacy `yes`/`no` values are also supported
- `pending` (optional, integer enum[1, 0]): Put the entry into pending activation (premoderation). Default - disabled. Legacy `yes`/`no` values are also supported
- `includehtml_desc` (optional, integer enum[1, 0]): Allow HTML in the short description. Default - enabled. Legacy `yes`/`no` values are also supported
- `includehtml_msg` (optional, integer enum[1, 0]): Allow HTML in the full description. Default - enabled. Legacy `yes`/`no` values are also supported
- `end2br_desc` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the short description. Default - disabled. Legacy `yes`/`no` values are also supported
- `end2br_msg` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the full description. Default - disabled. Legacy `yes`/`no` values are also supported
- `subscribe` (optional, integer enum[1, 0]): Subscribe to entry comments. Default - disabled. Legacy `yes`/`no` values are also supported
- `show_attach` (optional, integer enum[1, 0]): Show the attached file in the entry. Default - disabled. Legacy `yes`/`no` values are also supported
- `uto` (optional, integer enum[1, 0]): Replace external links using the u.to service. Default - disabled. Legacy `yes`/`no` values are also supported
- `cover` (optional, string(binary)): Entry cover - `jpg`/`jpeg`/`jpe`/`png`/`gif`/`webp` image. Sent only in `multipart/form-data`. Maximum size - the module cover setting (KB). Works when the "Entry cover" field is enabled.
- `file1` (optional, string(binary)): Embedded image in entry text - slots `file1`, `file2`, ... up to the module settings limit (up to 50 - for groups with the right to edit all entries). Extensions: `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp`; maximum size - module setting (KB). Sent only in `multipart/form-data`. Works when the "Images" field is enabled. Uploaded images are returned in the `files` array of responses.
- `file` (optional, string(binary)): Attached file (the "Attach file" field) - an arbitrary file downloadable from the entry page. Sent only in `multipart/form-data`. Maximum size is limited by the site plan. Works when the "Attach file" field is enabled in module settings.
- `add_date` (optional, string): Entry publication date and time as `yyyy-mm-dd hh:mm`. Works if the "add date" option is enabled in the control panel
- `meta_title` (optional, string): Meta Title
- `meta_description` (optional, string): Meta Description
- `meta_keywords` (optional, string): Meta Keywords
- `ownurl` (optional, string): Entry custom URL (SEO-friendly)
- `other1` (optional, string): Additional field 1 (max length - site plan limit)
- `other2` (optional, string): Additional field 2
- `other3` (optional, string): Additional field 3
- `other4` (optional, string): Additional field 4
- `other5` (optional, string): Additional field 5
- `author` (optional, string): Existing user nickname. Deprecated - use `author_id`. Available to module administrators and editors only.
- `author_id` (optional, integer): User ID - publish entry on their behalf. Takes priority over `author`. Available to module administrators and editors only.
- `tags` (optional, string): Entry tags, comma-separated (tag1,tag2,tag3)

### `PUT` `/news` — Edit entry

Edit an existing entry. PATCH semantics apply: omitted fields `title`, `pending`, `ontop`, `comments`, `author`, `show_attach`, `subscribe`, `hgu_title`, `other1`…`other5` keep their current values. File fields (`cover`, `file1`…`fileN`, `file`) are sent only in `multipart/form-data`.

**Parameters:**
- `id` (query, required, integer): Entry ID

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `category` (optional, integer | string): Category ID or a comma-separated list of IDs (`3` or `3,4`). When sent, fully replaces the entry's current category set (e.g. entry was in 3 and 4; after `category=4` it remains only in 4). A list works only when the module option "Allow an entry to belong to multiple categories" is enabled. The primary category is determined by the category order in the control panel, not by the order of IDs in…
- `title` (optional, string): Entry title. Up to 150 characters
- `description` (optional, string): Short description. Up to 1030 characters (up to 10000 - for groups with the right to edit all entries)
- `message` (optional, string): Full description. The maximum length is limited by the site plan
- `description_type` (optional, string enum['plain', 'bb', 'html']): Short description text format: `plain` - plain text (default), `bb` - BB codes, `html` - HTML
- `message_type` (optional, string enum['plain', 'bb', 'html']): Full description text format: `plain` - plain text (default), `bb` - BB codes, `html` - HTML
- `comments` (optional, integer enum[1, 0]): Allow comments. Omitted - the current value is kept. Legacy `yes`/`no` values are also supported
- `ontop` (optional, integer enum[1, 0]): Always show the entry at the top. Omitted - the current value is kept. Legacy `yes`/`no` values are also supported
- `pending` (optional, integer enum[1, 0]): Pending activation (premoderation). Omitted - the current value is kept. Legacy `yes`/`no` values are also supported
- `includehtml_desc` (optional, integer enum[1, 0]): Allow HTML in the short description. Default - enabled. Legacy `yes`/`no` values are also supported
- `includehtml_msg` (optional, integer enum[1, 0]): Allow HTML in the full description. Default - enabled. Legacy `yes`/`no` values are also supported
- `end2br_desc` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the short description. Default - disabled. Legacy `yes`/`no` values are also supported
- `end2br_msg` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the full description. Default - disabled. Legacy `yes`/`no` values are also supported
- `subscribe` (optional, integer enum[1, 0]): Subscription to comments. Omitted - the current value is kept. Legacy `yes`/`no` values are also supported
- `show_attach` (optional, integer enum[1, 0]): Show the attached file. Omitted - the current value is kept. Legacy `yes`/`no` values are also supported
- `uto` (optional, integer enum[1, 0]): Replace external links using the u.to service. Default - disabled. Legacy `yes`/`no` values are also supported
- `hgu_title` (optional, string): Entry SEO-friendly URL. Omitted - the current value is kept
- `cover` (optional, string(binary)): Entry cover - `jpg`/`jpeg`/`jpe`/`png`/`gif`/`webp` image. Sent only in `multipart/form-data`; replaces the current cover. Maximum size - the module cover setting (KB).
- `cover_delete` (optional, integer enum[0, 1]): 1 — remove the current cover when editing (if one was uploaded); 0 — keep it
- `file1` (optional, string(binary)): Embedded image in entry text - slots `file1`, `file2`, ... up to the module settings limit. Extensions: `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp`. Sent only in `multipart/form-data`. PATCH semantics: a slot without an uploaded file keeps its current image. Remove a slot with `del_imgN=1`.
- `del_img1` (optional, integer enum[0, 1]): 1 - remove embedded image in slot 1 (when embedded images are enabled). Same for `del_img2`, `del_img3`, ...
- `file` (optional, string(binary)): Attached file (the "Attach file" field). Sent only in `multipart/form-data`; replaces the current file. Maximum size is limited by the site plan. Works when the "Attach file" field is enabled.
- `meta_title` (optional, string): Meta Title
- `meta_description` (optional, string): Meta Description
- `meta_keywords` (optional, string): Meta Keywords
- `ownurl` (optional, string): Entry custom URL (SEO-friendly)
- `other1` (optional, string): Additional field 1 (max length - site plan limit)
- `other2` (optional, string): Additional field 2
- `other3` (optional, string): Additional field 3
- `other4` (optional, string): Additional field 4
- `other5` (optional, string): Additional field 5
- `author` (optional, string): Existing user nickname. Deprecated - use `author_id`. Available to module administrators and editors only.
- `author_id` (optional, integer): User ID - republish entry on their behalf. Takes priority over `author`. Available to module administrators and editors only.
- `add_date` (optional, string): Entry publication date and time as yyyy-mm-dd hh:mm. Works if "add date" is enabled in the control panel
- `uplastmod` (optional, integer enum[0, 1]): 1 — write the current server time into the entry modification date. 0 or omitted — leave the modification date unchanged even if the entry was edited. An arbitrary date cannot be set with this field. The parameter only works for users with full edit rights for the module; for everyone else it is silently ignored. The result appears in the `mod_date` / `mod_date_ts` fields of the module list respo…

### `DELETE` `/news/posts` — Delete entry

Delete entry from module

**Parameters:**
- `id` (query, required, integer): Entry ID

### `POST` `/news/tags` — Add/update entry tags

Add, update, or remove entry tags. - To remove all tags, send an empty request - To edit tags, send the full list of tags to keep - To add tags, send existing tags plus new ones Tags are comma-separated.

**Request body** (`application/x-www-form-urlencoded`):
- `id` (required, integer): Entry ID
- `tags` (optional, string): Comma-separated tag list

### `GET` `/news/category` — Get category list

Get all categories in the "Site news" module

**Parameters:**
- `id` (query, optional, integer): ID of a specific category

### `POST` `/news/category` — Add category

Add new category

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `name` (required, string): Category name
- `description` (optional, string): Category description
- `hgu_title` (optional, string): Category SEO-friendly URL
- `ownurl` (optional, string): Custom category slug (without domain)
- `position` (optional, integer): Category position in the list
- `access2category` (optional, string): Comma-separated group IDs allowed to view the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2add` (optional, string): Comma-separated group IDs allowed to add entries to the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2page` (optional, string): Comma-separated group IDs allowed to view the category page. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `file` (optional, string(binary)): Category image

### `PUT` `/news/category` — Edit category

Edit existing category

**Parameters:**
- `id` (query, required, integer): Category ID

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `name` (optional, string)
- `description` (optional, string)
- `hgu_title` (optional, string)
- `ownurl` (optional, string): Custom category slug (without domain)
- `position` (optional, integer)
- `access2category` (optional, string): Comma-separated group IDs allowed to view the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2add` (optional, string): Comma-separated group IDs allowed to add entries to the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2page` (optional, string): Comma-separated group IDs allowed to view the category page. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `file` (optional, string(binary)): Category image

### `DELETE` `/news/category` — Delete category

**Parameters:**
- `id` (query, required, integer): Category ID

### `GET` `/news/comments` — Get entry comments

Get all comments for a specific entry

**Parameters:**
- `id` (query, required, integer): Entry ID

### `POST` `/news/comments` — Add comment

Add comment to entry

**Request body** (`application/x-www-form-urlencoded`):
- `entry_id` (required, integer): Entry ID
- `message` (required, string): Comment text
- `pros` (optional, string): Entry pros
- `cons` (optional, string): Entry cons
- `parent_id` (optional, integer): Parent comment ID (for replies)
- `user_id` (optional, integer): User ID on whose behalf the comment is added. Works only when called by a user with permission to edit all comments.
- `subscribe_to_replies` (optional, string): Subscribe the authenticated user to replies for the entry after adding the comment. Value 0/no does not create a subscription; 1/yes creates a subscription. By default, the subscription is created.

### `PUT` `/news/comments` — Edit comment

Edit existing comment

**Parameters:**
- `id` (query, required, integer): Comment ID

**Request body** (`application/x-www-form-urlencoded`):
- `message` (optional, string): Comment text
- `pros` (optional, string): Entry pros
- `cons` (optional, string): Entry cons

### `DELETE` `/news/comments` — Delete comment

**Parameters:**
- `id` (query, required, integer): Comment ID

### `GET` `/news/filter` — Get filter list

Get all module filters

**Parameters:**
- `filter_id` (query, optional, integer): Filter ID

### `POST` `/news/filter` — Add filter

Add new filter

**Request body** (`application/x-www-form-urlencoded`):
- `filter_num` (required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)
- `name` (required, string): Filter name
- `items` (required, string): Values separated by |
- `multiselect` (optional, string enum[True, False]): Multiple selection (yes/no)
- `multi4userdisabled` (optional, string enum[True, False]): Disable multiple selection for regular users (yes/no)

### `PUT` `/news/filter` — Update filter

Update existing filter

**Request body** (`application/x-www-form-urlencoded`):
- `filter_num` (required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)
- `name` (optional, string): New filter name
- `items` (optional, string): New values separated by |
- `multiselect` (optional, string enum[True, False])
- `multi4userdisabled` (optional, string enum[True, False])

### `DELETE` `/news/filter` — Delete filter

Delete module filter

**Parameters:**
- `filter_num` (query, required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)

### `GET` `/news/fields` — Get module field settings

Shows available module fields

---
## Blog Module

OpenAPI: https://api.ucoz.net/blog-openapi.yaml

| Method | Path | Summary |
|---|---|---|
| `GET` | `/blog` | Get all module entries |
| `POST` | `/blog` | Add entry |
| `PUT` | `/blog` | Edit entry |
| `DELETE` | `/blog/posts` | Delete entry |
| `POST` | `/blog/tags` | Add/update entry tags |
| `GET` | `/blog/category` | Get category list |
| `POST` | `/blog/category` | Add category |
| `PUT` | `/blog/category` | Edit category |
| `DELETE` | `/blog/category` | Delete category |
| `GET` | `/blog/comments` | Get entry comments |
| `POST` | `/blog/comments` | Add comment |
| `PUT` | `/blog/comments` | Edit comment |
| `DELETE` | `/blog/comments` | Delete comment |
| `GET` | `/blog/filter` | Get filter list |
| `POST` | `/blog/filter` | Add filter |
| `PUT` | `/blog/filter` | Update filter |
| `DELETE` | `/blog/filter` | Delete filter |
| `GET` | `/blog/fields` | Get module field settings |

### `GET` `/blog` — Get all module entries

Get a list of all entries in the "Blog" module

**Parameters:**
- `page` (query, optional, integer): Page number.
- `per_page` (query, optional, integer): Number of entries per page.
- `id` (query, optional, integer): ID of a specific entry
- `date` (query, optional, string): Filter by date in yyyy-mm-dd or yyyy format
- `category` (query, optional, integer): Filter by category ID (non-existing category — `NOT_FOUND`)
- `user_id` (query, optional, integer): Filter by numeric ID of the entry author
- `pending` (query, optional, integer): Non-zero value — return only entries pending activation (premoderation)

### `POST` `/blog` — Add entry

Add a new entry to the "Blog" module Text fields can be sent in `application/x-www-form-urlencoded`. File fields (`cover`, `file1`…`fileN`) are sent only in `multipart/form-data` (text fields may go in the same request).

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `category` (required, integer | string): Category ID or a comma-separated list of IDs (`3` or `3,4`). A list works only when the module option "Allow an entry to belong to multiple categories" is enabled (`options_other_categories` / `other_categories` in `/setup`). The primary category is determined by the category order in the control panel, not by the order of IDs in the submitted list. Parameters `ocat`, `ocats`, `categories`, and `…
- `title` (required, string): Entry title
- `description` (optional, string): Short entry description
- `message` (optional, string): Full entry description
- `description_type` (optional, string enum['plain', 'bb', 'html']): Short description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `message_type` (optional, string enum['plain', 'bb', 'html']): Full description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `comments` (optional, integer enum[1, 0]): Allow comments on the entry Default — enabled. Legacy `yes`/`no` values are also supported
- `ontop` (optional, integer enum[1, 0]): Always show the entry at the top Default — disabled. Legacy `yes`/`no` values are also supported
- `pending` (optional, integer enum[1, 0]): Put the entry into pending activation (premoderation) Default — disabled. Legacy `yes`/`no` values are also supported
- `includehtml_desc` (optional, integer enum[1, 0]): Allow HTML in the short description Default — enabled. Legacy `yes`/`no` values are also supported
- `includehtml_msg` (optional, integer enum[1, 0]): Allow HTML in the full description Default — enabled. Legacy `yes`/`no` values are also supported
- `end2br_desc` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the short description Default — disabled. Legacy `yes`/`no` values are also supported
- `end2br_msg` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the full description Default — disabled. Legacy `yes`/`no` values are also supported
- `subscribe` (optional, integer enum[1, 0]): Subscribe to entry comments Default — disabled. Legacy `yes`/`no` values are also supported
- `uto` (optional, integer enum[1, 0]): Replace external links using the u.to service Default — disabled. Legacy `yes`/`no` values are also supported
- `show_attach` (optional, integer enum[1, 0]): Show the attached file in the entry Default — disabled. Legacy `yes`/`no` values are also supported
- `cover` (optional, string(binary)): Entry cover — `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp` image. Sent only in `multipart/form-data`. Maximum size — the cover setting (KB)
- `file1` (optional, string(binary)): Embedded image in entry text — slots `file1`, `file2`, … up to the module settings limit. Extensions: `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp`; maximum size — module setting (KB). Sent only in `multipart/form-data`. Uploaded images are returned in the `files` array of responses.
- `add_date` (optional, string): Publication date and time as `yyyy-mm-dd hh:mm`. Works if the "add date" option is enabled in the control panel
- `meta_title` (optional, string): Meta Title
- `meta_description` (optional, string): Meta Description
- `meta_keywords` (optional, string): Meta Keywords
- `ownurl` (optional, string): Entry custom URL (SEO-friendly)
- `other1` (optional, string): Additional field 1 (max length — site plan limit)
- `other2` (optional, string): Additional field 2 (max length — site plan limit)
- `other3` (optional, string): Additional field 3 (max length — site plan limit)
- `other4` (optional, string): Additional field 4 (max length — site plan limit)
- `other5` (optional, string): Additional field 5 (max length — site plan limit)
- `author` (optional, string): Existing user nickname. Deprecated — use `author_id`. Available to module administrators and editors only.
- `author_id` (optional, integer): User ID — publish entry on their behalf. Takes priority over `author`. Available to module administrators and editors only.
- `tags` (optional, string): Entry tags, comma-separated (tag1,tag2,tag3)

### `PUT` `/blog` — Edit entry

Edit an existing entry PATCH semantics apply: omitted fields keep their current values. File fields (`cover`, `file1`…`fileN`) are sent only in `multipart/form-data`.

**Parameters:**
- `id` (query, required, integer): Entry ID

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `category` (optional, integer | string): Category ID or a comma-separated list of IDs (`3` or `3,4`). When sent, fully replaces the entry's current category set (e.g. entry was in 3 and 4; after `category=4` it remains only in 4). A list works only when the module option "Allow an entry to belong to multiple categories" is enabled. The primary category is determined by the category order in the control panel, not by the order of IDs in…
- `title` (optional, string): Entry title
- `description` (optional, string): Short entry description
- `message` (optional, string): Full entry description
- `description_type` (optional, string enum['plain', 'bb', 'html']): Short description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `message_type` (optional, string enum['plain', 'bb', 'html']): Full description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `comments` (optional, integer enum[1, 0]): Allow comments on the entry Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `ontop` (optional, integer enum[1, 0]): Always show the entry at the top Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `pending` (optional, integer enum[1, 0]): Put the entry into pending activation (premoderation) Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `includehtml_desc` (optional, integer enum[1, 0]): Allow HTML in the short description Default — enabled. Legacy `yes`/`no` values are also supported
- `includehtml_msg` (optional, integer enum[1, 0]): Allow HTML in the full description Default — enabled. Legacy `yes`/`no` values are also supported
- `end2br_desc` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the short description Default — disabled. Legacy `yes`/`no` values are also supported
- `end2br_msg` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the full description Default — disabled. Legacy `yes`/`no` values are also supported
- `subscribe` (optional, integer enum[1, 0]): Subscribe to entry comments Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `uto` (optional, integer enum[1, 0]): Replace external links using the u.to service Default — disabled. Legacy `yes`/`no` values are also supported
- `show_attach` (optional, integer enum[1, 0]): Show the attached file in the entry Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `hgu_title` (optional, string): Entry SEO-friendly URL. Omitted — the current value is kept
- `cover` (optional, string(binary)): Entry cover — `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp` image. Sent only in `multipart/form-data`. Maximum size — the cover setting (KB)
- `cover_delete` (optional, integer enum[0, 1]): 1 — remove the current cover when editing (if one was uploaded); 0 — keep it
- `file1` (optional, string(binary)): Embedded image — slots `file1`, `file2`, …; `multipart/form-data` only. PATCH semantics: a slot without an uploaded file keeps its current image. Remove a slot with `del_imgN=1`.
- `del_img1` (optional, integer enum[0, 1]): 1 — remove embedded image in slot 1. Same for `del_img2`, `del_img3`, …
- `add_date` (optional, string): Publication date and time as `yyyy-mm-dd hh:mm`. Works if the "add date" option is enabled in the control panel
- `uplastmod` (optional, integer enum[0, 1]): 1 — write the current server time into the entry modification date. 0 or omitted — leave the modification date unchanged even if the entry was edited. An arbitrary date cannot be set with this field. The parameter only works for users with full edit rights for the module; for everyone else it is silently ignored. The result appears in the `mod_date` / `mod_date_ts` fields of the module list respo…
- `meta_title` (optional, string): Meta Title
- `meta_description` (optional, string): Meta Description
- `meta_keywords` (optional, string): Meta Keywords
- `ownurl` (optional, string): Entry custom URL (SEO-friendly)
- `other1` (optional, string): Additional field 1 (max length — site plan limit)
- `other2` (optional, string): Additional field 2 (max length — site plan limit)
- `other3` (optional, string): Additional field 3 (max length — site plan limit)
- `other4` (optional, string): Additional field 4 (max length — site plan limit)
- `other5` (optional, string): Additional field 5 (max length — site plan limit)
- `author` (optional, string): Existing user nickname. Deprecated — use `author_id`. Available to module administrators and editors only.
- `author_id` (optional, integer): User ID — publish entry on their behalf. Takes priority over `author`. Available to module administrators and editors only.

### `DELETE` `/blog/posts` — Delete entry

Delete an entry from the module

**Parameters:**
- `id` (query, required, integer): Entry ID

### `POST` `/blog/tags` — Add/update entry tags

Add, change, or remove tags for an entry

**Request body** (`application/x-www-form-urlencoded`):
- `id` (required, integer): Entry ID
- `tags` (optional, string): Comma-separated list of tags

### `GET` `/blog/category` — Get category list

Get all module categories

**Parameters:**
- `id` (query, optional, integer): ID of a specific category

### `POST` `/blog/category` — Add category

Add a new category

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `name` (required, string): Category name
- `description` (optional, string)
- `hgu_title` (optional, string)
- `ownurl` (optional, string): Custom category slug (without domain)
- `position` (optional, integer)
- `access2category` (optional, string): Comma-separated group IDs allowed to view the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2add` (optional, string): Comma-separated group IDs allowed to add entries to the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2page` (optional, string): Comma-separated group IDs allowed to view the category page. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `file` (optional, string(binary)): Category image

### `PUT` `/blog/category` — Edit category

Edit an existing category

**Parameters:**
- `id` (query, required, integer): Category ID

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `name` (optional, string)
- `description` (optional, string)
- `hgu_title` (optional, string)
- `ownurl` (optional, string): Custom category slug (without domain)
- `position` (optional, integer)
- `access2category` (optional, string): Comma-separated group IDs allowed to view the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2add` (optional, string): Comma-separated group IDs allowed to add entries to the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2page` (optional, string): Comma-separated group IDs allowed to view the category page. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `file` (optional, string(binary)): Category image

### `DELETE` `/blog/category` — Delete category

**Parameters:**
- `id` (query, required, integer): Category ID

### `GET` `/blog/comments` — Get entry comments

Get all comments for a specific entry

**Parameters:**
- `id` (query, required, integer): Entry ID

### `POST` `/blog/comments` — Add comment

Add a comment to an entry

**Request body** (`application/x-www-form-urlencoded`):
- `entry_id` (required, integer): Entry ID
- `message` (required, string): Comment text
- `pros` (optional, string): Entry pros
- `cons` (optional, string): Entry cons
- `parent_id` (optional, integer): Parent comment ID
- `user_id` (optional, integer): User ID on whose behalf the comment is added. Works only when called by a user with permission to edit all comments.
- `subscribe_to_replies` (optional, string): Subscribe the authenticated user to replies for the entry after adding the comment. Value 0/no does not create a subscription; 1/yes creates a subscription. By default, the subscription is created.

### `PUT` `/blog/comments` — Edit comment

Edit an existing comment

**Parameters:**
- `id` (query, required, integer): Comment ID

**Request body** (`application/x-www-form-urlencoded`):
- `message` (optional, string)
- `pros` (optional, string): Entry pros
- `cons` (optional, string): Entry cons

### `DELETE` `/blog/comments` — Delete comment

**Parameters:**
- `id` (query, required, integer): Comment ID

### `GET` `/blog/filter` — Get filter list

Get all module filters

**Parameters:**
- `filter_id` (query, optional, integer): Filter ID

### `POST` `/blog/filter` — Add filter

Add a new filter

**Request body** (`application/x-www-form-urlencoded`):
- `filter_num` (required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)
- `name` (required, string): Filter name
- `items` (required, string): Values separated by |
- `multiselect` (optional, string enum[True, False]): Multiple selection (yes/no)
- `multi4userdisabled` (optional, string enum[True, False]): Multiple selection for regular users

### `PUT` `/blog/filter` — Update filter

Update an existing filter

**Request body** (`application/x-www-form-urlencoded`):
- `filter_num` (required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)
- `name` (optional, string): New filter name
- `items` (optional, string): New values separated by |
- `multiselect` (optional, string enum[True, False])
- `multi4userdisabled` (optional, string enum[True, False])

### `DELETE` `/blog/filter` — Delete filter

Delete a module filter

**Parameters:**
- `filter_num` (query, required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)

### `GET` `/blog/fields` — Get module field settings

Shows available module fields

---
## Publ Module

OpenAPI: https://api.ucoz.net/publ-openapi.yaml

| Method | Path | Summary |
|---|---|---|
| `GET` | `/publ` | Get all module entries |
| `POST` | `/publ` | Add entry |
| `PUT` | `/publ` | Edit entry |
| `DELETE` | `/publ/posts` | Delete entry |
| `POST` | `/publ/tags` | Add/update entry tags |
| `GET` | `/publ/category` | Get category/section list |
| `POST` | `/publ/category` | Add category/section |
| `PUT` | `/publ/category` | Edit category/section |
| `DELETE` | `/publ/category` | Delete category/section |
| `GET` | `/publ/comments` | Get entry comments |
| `POST` | `/publ/comments` | Add comment |
| `PUT` | `/publ/comments` | Edit comment |
| `DELETE` | `/publ/comments` | Delete comment |
| `GET` | `/publ/filter` | Get filter list |
| `POST` | `/publ/filter` | Add filter |
| `PUT` | `/publ/filter` | Update filter |
| `DELETE` | `/publ/filter` | Delete filter |
| `GET` | `/publ/fields` | Get module field settings |

### `GET` `/publ` — Get all module entries

Get a list of all entries in the "Publisher" module

**Parameters:**
- `page` (query, optional, integer): Page number.
- `per_page` (query, optional, integer): Entries per page.
- `id` (query, optional, integer): ID of a specific entry
- `category` (query, optional, integer): Category ID
- `user_id` (query, optional, integer): Filter by numeric ID of the entry author
- `pending` (query, optional, integer): Non-zero value — return only entries pending activation (premoderation)

### `POST` `/publ` — Add entry

Add a new entry to the "Publisher" module Text fields can be sent in `application/x-www-form-urlencoded`. File fields (`cover`, `file1`…`fileN`) are sent only in `multipart/form-data` (text fields may go in the same request).

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `category` (required, integer | string): Category ID or a comma-separated list of IDs (`3` or `3,4`). A list works only when the module option "Allow an entry to belong to multiple categories" is enabled (`options_other_categories` / `other_categories` in `/setup`). The primary category is determined by the category order in the control panel, not by the order of IDs in the submitted list. Parameters `ocat`, `ocats`, `categories`, and `…
- `title` (required, string): Entry title
- `description` (optional, string): Short entry description
- `message` (optional, string): Full entry description
- `description_type` (optional, string enum['plain', 'bb', 'html']): Short description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `message_type` (optional, string enum['plain', 'bb', 'html']): Full description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `comments` (optional, integer enum[1, 0]): Allow comments on the entry Default — enabled. Legacy `yes`/`no` values are also supported
- `ontop` (optional, integer enum[1, 0]): Always show the entry at the top Default — disabled. Legacy `yes`/`no` values are also supported
- `pending` (optional, integer enum[1, 0]): Put the entry into pending activation (premoderation) Default — disabled. Legacy `yes`/`no` values are also supported
- `includehtml_desc` (optional, integer enum[1, 0]): Allow HTML in the short description Default — enabled. Legacy `yes`/`no` values are also supported
- `includehtml_msg` (optional, integer enum[1, 0]): Allow HTML in the full description Default — enabled. Legacy `yes`/`no` values are also supported
- `end2br_desc` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the short description Default — disabled. Legacy `yes`/`no` values are also supported
- `end2br_msg` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the full description Default — disabled. Legacy `yes`/`no` values are also supported
- `subscribe` (optional, integer enum[1, 0]): Subscribe to entry comments Default — disabled. Legacy `yes`/`no` values are also supported
- `uto` (optional, integer enum[1, 0]): Replace external links using the u.to service Default — disabled. Legacy `yes`/`no` values are also supported
- `name` (optional, string): Display name of the entry author (the "Author name" field). Not to be confused with `author` — a user nickname
- `author_email` (optional, string): Author e-mail
- `author_site` (optional, string): Author website
- `link2source` (optional, string): Link to the entry source
- `cover` (optional, string(binary)): Entry cover — `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp` image. Sent only in `multipart/form-data`. Maximum size — the cover setting (KB)
- `file1` (optional, string(binary)): Embedded image in entry text — slots `file1`, `file2`, … up to the module settings limit. Extensions: `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp`; maximum size — module setting (KB). Sent only in `multipart/form-data`. Uploaded images are returned in the `files` array of responses.
- `add_date` (optional, string): Publication date and time as `yyyy-mm-dd hh:mm`. Works if the "add date" option is enabled in the control panel
- `meta_title` (optional, string): Meta Title
- `meta_description` (optional, string): Meta Description
- `meta_keywords` (optional, string): Meta Keywords
- `ownurl` (optional, string): Entry custom URL (SEO-friendly)
- `other1` (optional, string): Additional field 1 (max length — site plan limit)
- `other2` (optional, string): Additional field 2 (max length — site plan limit)
- `other3` (optional, string): Additional field 3 (max length — site plan limit)
- `other4` (optional, string): Additional field 4 (max length — site plan limit)
- `other5` (optional, string): Additional field 5 (max length — site plan limit)
- `author` (optional, string): Existing user nickname. Deprecated — use `author_id`. Available to module administrators and editors only.
- `author_id` (optional, integer): User ID — publish entry on their behalf. Takes priority over `author`. Available to module administrators and editors only.
- `tags` (optional, string): Entry tags, comma-separated (tag1,tag2,tag3)

### `PUT` `/publ` — Edit entry

Edit existing entry PATCH semantics apply: omitted fields keep their current values. File fields (`cover`, `file1`…`fileN`) are sent only in `multipart/form-data`.

**Parameters:**
- `id` (query, required, integer): Entry ID

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `category` (optional, integer | string): Category ID or a comma-separated list of IDs (`3` or `3,4`). When sent, fully replaces the entry's current category set (e.g. entry was in 3 and 4; after `category=4` it remains only in 4). A list works only when the module option "Allow an entry to belong to multiple categories" is enabled. The primary category is determined by the category order in the control panel, not by the order of IDs in…
- `title` (optional, string): Entry title
- `description` (optional, string): Short entry description
- `message` (optional, string): Full entry description
- `description_type` (optional, string enum['plain', 'bb', 'html']): Short description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `message_type` (optional, string enum['plain', 'bb', 'html']): Full description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `comments` (optional, integer enum[1, 0]): Allow comments on the entry Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `ontop` (optional, integer enum[1, 0]): Always show the entry at the top Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `pending` (optional, integer enum[1, 0]): Put the entry into pending activation (premoderation) Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `includehtml_desc` (optional, integer enum[1, 0]): Allow HTML in the short description Default — enabled. Legacy `yes`/`no` values are also supported
- `includehtml_msg` (optional, integer enum[1, 0]): Allow HTML in the full description Default — enabled. Legacy `yes`/`no` values are also supported
- `end2br_desc` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the short description Default — disabled. Legacy `yes`/`no` values are also supported
- `end2br_msg` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the full description Default — disabled. Legacy `yes`/`no` values are also supported
- `subscribe` (optional, integer enum[1, 0]): Subscribe to entry comments Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `uto` (optional, integer enum[1, 0]): Replace external links using the u.to service Default — disabled. Legacy `yes`/`no` values are also supported
- `name` (optional, string): Display name of the entry author (the "Author name" field). Not to be confused with `author` — a user nickname
- `author_email` (optional, string): Author e-mail
- `author_site` (optional, string): Author website
- `link2source` (optional, string): Link to the entry source
- `hgu_title` (optional, string): Entry SEO-friendly URL. Omitted — the current value is kept
- `cover` (optional, string(binary)): Entry cover — `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp` image. Sent only in `multipart/form-data`. Maximum size — the cover setting (KB)
- `cover_delete` (optional, integer enum[0, 1]): 1 — remove the current cover when editing (if one was uploaded); 0 — keep it
- `file1` (optional, string(binary)): Embedded image — slots `file1`, `file2`, …; `multipart/form-data` only. PATCH semantics: a slot without an uploaded file keeps its current image. Remove a slot with `del_imgN=1`.
- `del_img1` (optional, integer enum[0, 1]): 1 — remove embedded image in slot 1. Same for `del_img2`, `del_img3`, …
- `add_date` (optional, string): Publication date and time as `yyyy-mm-dd hh:mm`. Works if the "add date" option is enabled in the control panel
- `uplastmod` (optional, integer enum[0, 1]): 1 — write the current server time into the entry modification date. 0 or omitted — leave the modification date unchanged even if the entry was edited. An arbitrary date cannot be set with this field. The parameter only works for users with full edit rights for the module; for everyone else it is silently ignored. The result appears in the `mod_date` / `mod_date_ts` fields of the module list respo…
- `meta_title` (optional, string): Meta Title
- `meta_description` (optional, string): Meta Description
- `meta_keywords` (optional, string): Meta Keywords
- `ownurl` (optional, string): Entry custom URL (SEO-friendly)
- `other1` (optional, string): Additional field 1 (max length — site plan limit)
- `other2` (optional, string): Additional field 2 (max length — site plan limit)
- `other3` (optional, string): Additional field 3 (max length — site plan limit)
- `other4` (optional, string): Additional field 4 (max length — site plan limit)
- `other5` (optional, string): Additional field 5 (max length — site plan limit)
- `author` (optional, string): Existing user nickname. Deprecated — use `author_id`. Available to module administrators and editors only.
- `author_id` (optional, integer): User ID — publish entry on their behalf. Takes priority over `author`. Available to module administrators and editors only.

### `DELETE` `/publ/posts` — Delete entry

Delete entry from module

**Parameters:**
- `id` (query, required, integer): Entry ID

### `POST` `/publ/tags` — Add/update entry tags

Add, update, or remove entry tags

**Request body** (`application/x-www-form-urlencoded`):
- `id` (required, integer): Entry ID
- `tags` (optional, string): Comma-separated tag list

### `GET` `/publ/category` — Get category/section list

Get all module categories and sections

**Parameters:**
- `id` (query, optional, integer): ID of a specific category

### `POST` `/publ/category` — Add category/section

Add new category or section

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `name` (required, string): Category/section name
- `description` (optional, string)
- `hgu_title` (optional, string)
- `ownurl` (optional, string): Custom category slug (without domain)
- `position` (optional, integer)
- `access2category` (optional, string): Comma-separated group IDs allowed to view the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2add` (optional, string): Comma-separated group IDs allowed to add entries to the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2page` (optional, string): Comma-separated group IDs allowed to view the category page. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `file` (optional, string(binary)): Category image

### `PUT` `/publ/category` — Edit category/section

Edit existing category or section

**Parameters:**
- `id` (query, required, integer): Category ID

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `name` (optional, string)
- `description` (optional, string)
- `hgu_title` (optional, string)
- `ownurl` (optional, string): Custom category slug (without domain)
- `position` (optional, integer)
- `access2category` (optional, string): Comma-separated group IDs allowed to view the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2add` (optional, string): Comma-separated group IDs allowed to add entries to the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2page` (optional, string): Comma-separated group IDs allowed to view the category page. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `file` (optional, string(binary)): Category image

### `DELETE` `/publ/category` — Delete category/section

Delete category or section

**Parameters:**
- `id` (query, required, integer): Category ID

### `GET` `/publ/comments` — Get entry comments

Get all comments for a specific entry

**Parameters:**
- `id` (query, required, integer): Entry ID

### `POST` `/publ/comments` — Add comment

Add comment to entry

**Request body** (`application/x-www-form-urlencoded`):
- `entry_id` (required, integer): Entry ID
- `message` (required, string): Comment text
- `pros` (optional, string): Entry pros
- `cons` (optional, string): Entry cons
- `parent_id` (optional, integer): Parent comment ID
- `user_id` (optional, integer): User ID on whose behalf the comment is added. Works only when called by a user with permission to edit all comments.
- `subscribe_to_replies` (optional, string): Subscribe the authenticated user to replies for the entry after adding the comment. Value 0/no does not create a subscription; 1/yes creates a subscription. By default, the subscription is created.

### `PUT` `/publ/comments` — Edit comment

Edit existing comment

**Parameters:**
- `id` (query, required, integer): Comment ID

**Request body** (`application/x-www-form-urlencoded`):
- `message` (optional, string)
- `pros` (optional, string): Entry pros
- `cons` (optional, string): Entry cons

### `DELETE` `/publ/comments` — Delete comment

**Parameters:**
- `id` (query, required, integer): Comment ID

### `GET` `/publ/filter` — Get filter list

Get all module filters

**Parameters:**
- `filter_id` (query, optional, integer): Filter ID

### `POST` `/publ/filter` — Add filter

Add new filter

**Request body** (`application/x-www-form-urlencoded`):
- `filter_num` (required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)
- `name` (required, string): Filter name
- `items` (required, string): Values separated by |
- `multiselect` (optional, string enum[True, False]): Multiple selection (yes/no)
- `multi4userdisabled` (optional, string enum[True, False]): Multiple selection for regular users

### `PUT` `/publ/filter` — Update filter

Update existing filter

**Request body** (`application/x-www-form-urlencoded`):
- `filter_num` (required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)
- `name` (optional, string): New filter name
- `items` (optional, string): New values separated by |
- `multiselect` (optional, string enum[True, False])
- `multi4userdisabled` (optional, string enum[True, False])

### `DELETE` `/publ/filter` — Delete filter

Delete module filter

**Parameters:**
- `filter_num` (query, required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)

### `GET` `/publ/fields` — Get module field settings

Shows available module fields

---
## Board Module

OpenAPI: https://api.ucoz.net/board-openapi.yaml

| Method | Path | Summary |
|---|---|---|
| `GET` | `/board` | Get all module entries |
| `POST` | `/board` | Add entry |
| `PUT` | `/board` | Edit entry |
| `DELETE` | `/board/posts` | Delete entry |
| `POST` | `/board/tags` | Add/update entry tags |
| `GET` | `/board/category` | Get category/section list |
| `POST` | `/board/category` | Add category/section |
| `PUT` | `/board/category` | Edit category/section |
| `DELETE` | `/board/category` | Delete category/section |
| `GET` | `/board/comments` | Get entry comments |
| `POST` | `/board/comments` | Add comment |
| `PUT` | `/board/comments` | Edit comment |
| `DELETE` | `/board/comments` | Delete comment |
| `GET` | `/board/filter` | Get filter list |
| `POST` | `/board/filter` | Add filter |
| `PUT` | `/board/filter` | Update filter |
| `DELETE` | `/board/filter` | Delete filter |
| `GET` | `/board/fields` | Get module field settings |

### `GET` `/board` — Get all module entries

Get a list of all entries in the "Ad board" module

**Parameters:**
- `page` (query, optional, integer): Page number.
- `per_page` (query, optional, integer): Number of entries per page.
- `id` (query, optional, integer): ID of a specific entry
- `category` (query, optional, integer): Category ID
- `user_id` (query, optional, integer): Filter by numeric ID of the entry author
- `pending` (query, optional, integer): Non-zero value — return only entries pending activation (premoderation)

### `POST` `/board` — Add entry

Add a new entry to the "Ad board" module Text fields can be sent in `application/x-www-form-urlencoded`. File fields (`screenshot`, `archive`, `cover`, `file1`…`fileN`) are sent only in `multipart/form-data` (text fields may go in the same request).

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `category` (required, integer | string): Category ID or a comma-separated list of IDs (`3` or `3,4`). A list works only when the module option "Allow an entry to belong to multiple categories" is enabled (`options_other_categories` / `other_categories` in `/setup`). The primary category is determined by the category order in the control panel, not by the order of IDs in the submitted list. Parameters `ocat`, `ocats`, `categories`, and `…
- `title` (required, string): Entry title
- `description` (optional, string): Short entry description
- `message` (optional, string): Full entry description
- `description_type` (optional, string enum['plain', 'bb', 'html']): Short description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `message_type` (optional, string enum['plain', 'bb', 'html']): Full description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `comments` (optional, integer enum[1, 0]): Allow comments on the entry Default — enabled. Legacy `yes`/`no` values are also supported
- `ontop` (optional, integer enum[1, 0]): Always show the entry at the top Default — disabled. Legacy `yes`/`no` values are also supported
- `pending` (optional, integer enum[1, 0]): Put the entry into pending activation (premoderation) Default — disabled. Legacy `yes`/`no` values are also supported
- `includehtml_desc` (optional, integer enum[1, 0]): Allow HTML in the short description Default — enabled. Legacy `yes`/`no` values are also supported
- `includehtml_msg` (optional, integer enum[1, 0]): Allow HTML in the full description Default — enabled. Legacy `yes`/`no` values are also supported
- `end2br_desc` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the short description Default — disabled. Legacy `yes`/`no` values are also supported
- `end2br_msg` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the full description Default — disabled. Legacy `yes`/`no` values are also supported
- `subscribe` (optional, integer enum[1, 0]): Subscribe to entry comments Default — disabled. Legacy `yes`/`no` values are also supported
- `uto` (optional, integer enum[1, 0]): Replace external links using the u.to service Default — disabled. Legacy `yes`/`no` values are also supported
- `name` (optional, string): Ad contact person
- `author_email` (optional, string): Author e-mail
- `author_site` (optional, string): Author website
- `author_phone` (optional, string): Contact phone number
- `till_date` (optional, string): Ad placement end date as `yyyy-mm-dd` or `yyyy-mm-dd hh:mm`. Invalid format — `INVALID_DATETIME`. Omitted — 31 days from now
- `ontop_period` (optional, string enum['day', 'week', 'month']): Pin the ad at the top for a period: `day`, `week` or `month` (if allowed for group). Other values — `INVALID_DATETIME`
- `filter1` (optional, string): Filter 1 values — comma-separated value IDs (see `GET /board/filter`). Whether it is required depends on module settings
- `filter2` (optional, string): Filter 2 values — comma-separated value IDs (see `GET /board/filter`). Whether it is required depends on module settings
- `filter3` (optional, string): Filter 3 values — comma-separated value IDs (see `GET /board/filter`). Whether it is required depends on module settings
- `screenshot` (optional, string(binary)): Entry screenshot — `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp` image. Sent only in `multipart/form-data`. Maximum size — module setting (KB)
- `archive` (optional, string(binary)): Archive file (arbitrary downloadable file). Sent only in `multipart/form-data`. Maximum size is limited by site settings/plan
- `cover` (optional, string(binary)): Entry cover — `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp` image. Sent only in `multipart/form-data`. Maximum size — the cover setting (KB)
- `file1` (optional, string(binary)): Embedded image in entry text — slots `file1`, `file2`, … up to the module settings limit. Extensions: `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp`; maximum size — module setting (KB). Sent only in `multipart/form-data`. Uploaded images are returned in the `files` array of responses.
- `add_date` (optional, string): Publication date and time as `yyyy-mm-dd hh:mm`. Works if the "add date" option is enabled in the control panel
- `meta_title` (optional, string): Meta Title
- `meta_description` (optional, string): Meta Description
- `meta_keywords` (optional, string): Meta Keywords
- `ownurl` (optional, string): Entry custom URL (SEO-friendly)
- `other1` (optional, string): Additional field 1 (max length — site plan limit)
- `other2` (optional, string): Additional field 2 (max length — site plan limit)
- `other3` (optional, string): Additional field 3 (max length — site plan limit)
- `other4` (optional, string): Additional field 4 (max length — site plan limit)
- `other5` (optional, string): Additional field 5 (max length — site plan limit)
- `author` (optional, string): Existing user nickname. Deprecated — use `author_id`. Available to module administrators and editors only.
- `author_id` (optional, integer): User ID — publish entry on their behalf. Takes priority over `author`. Available to module administrators and editors only.
- `tags` (optional, string): Entry tags, comma-separated (tag1,tag2,tag3)

### `PUT` `/board` — Edit entry

Edit an existing entry PATCH semantics apply: omitted fields keep their current values. File fields (`screenshot`, `archive`, `cover`, `file1`…`fileN`) are sent only in `multipart/form-data`.

**Parameters:**
- `id` (query, required, integer): Entry ID

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `category` (optional, integer | string): Category ID or a comma-separated list of IDs (`3` or `3,4`). When sent, fully replaces the entry's current category set (e.g. entry was in 3 and 4; after `category=4` it remains only in 4). A list works only when the module option "Allow an entry to belong to multiple categories" is enabled. The primary category is determined by the category order in the control panel, not by the order of IDs in…
- `title` (optional, string): Entry title
- `description` (optional, string): Short entry description
- `message` (optional, string): Full entry description
- `description_type` (optional, string enum['plain', 'bb', 'html']): Short description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `message_type` (optional, string enum['plain', 'bb', 'html']): Full description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `comments` (optional, integer enum[1, 0]): Allow comments on the entry Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `ontop` (optional, integer enum[1, 0]): Always show the entry at the top Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `pending` (optional, integer enum[1, 0]): Put the entry into pending activation (premoderation) Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `includehtml_desc` (optional, integer enum[1, 0]): Allow HTML in the short description Default — enabled. Legacy `yes`/`no` values are also supported
- `includehtml_msg` (optional, integer enum[1, 0]): Allow HTML in the full description Default — enabled. Legacy `yes`/`no` values are also supported
- `end2br_desc` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the short description Default — disabled. Legacy `yes`/`no` values are also supported
- `end2br_msg` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the full description Default — disabled. Legacy `yes`/`no` values are also supported
- `subscribe` (optional, integer enum[1, 0]): Subscribe to entry comments Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `uto` (optional, integer enum[1, 0]): Replace external links using the u.to service Default — disabled. Legacy `yes`/`no` values are also supported
- `name` (optional, string): Ad contact person
- `author_email` (optional, string): Author e-mail
- `author_site` (optional, string): Author website
- `author_phone` (optional, string): Contact phone number
- `till_date` (optional, string): Ad placement end date as `yyyy-mm-dd` or `yyyy-mm-dd hh:mm`. Invalid format — `INVALID_DATETIME`. Omitted — 31 days from now
- `ontop_period` (optional, string enum['day', 'week', 'month']): Pin the ad at the top for a period: `day`, `week` or `month` (if allowed for group). Other values — `INVALID_DATETIME`
- `filter1` (optional, string): Filter 1 values — comma-separated value IDs (see `GET /board/filter`). Whether it is required depends on module settings
- `filter2` (optional, string): Filter 2 values — comma-separated value IDs (see `GET /board/filter`). Whether it is required depends on module settings
- `filter3` (optional, string): Filter 3 values — comma-separated value IDs (see `GET /board/filter`). Whether it is required depends on module settings
- `hgu_title` (optional, string): Entry SEO-friendly URL. Omitted — the current value is kept
- `screenshot` (optional, string(binary)): Entry screenshot — `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp` image. Sent only in `multipart/form-data`. Maximum size — module setting (KB)
- `archive` (optional, string(binary)): Archive file (arbitrary downloadable file). Sent only in `multipart/form-data`. Maximum size is limited by site settings/plan
- `cover` (optional, string(binary)): Entry cover — `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp` image. Sent only in `multipart/form-data`. Maximum size — the cover setting (KB)
- `cover_delete` (optional, integer enum[0, 1]): 1 — remove the current cover when editing (if one was uploaded); 0 — keep it
- `file1` (optional, string(binary)): Embedded image — slots `file1`, `file2`, …; `multipart/form-data` only. PATCH semantics: a slot without an uploaded file keeps its current image. Remove a slot with `del_imgN=1`.
- `del_img1` (optional, integer enum[0, 1]): 1 — remove embedded image in slot 1. Same for `del_img2`, `del_img3`, …
- `add_date` (optional, string): Publication date and time as `yyyy-mm-dd hh:mm`. Works if the "add date" option is enabled in the control panel
- `update_date` (optional, integer enum[0, 1]): 1 — write the current server time into the entry modification date. 0 or omitted — leave the modification date unchanged even if the entry was edited. Despite the name, an arbitrary date cannot be set with this parameter — it is a 0/1 flag. The parameter only works for users with full edit rights for the module; for everyone else it is silently ignored. The result appears in the `mod_date` / `mod…
- `meta_title` (optional, string): Meta Title
- `meta_description` (optional, string): Meta Description
- `meta_keywords` (optional, string): Meta Keywords
- `ownurl` (optional, string): Entry custom URL (SEO-friendly)
- `other1` (optional, string): Additional field 1 (max length — site plan limit)
- `other2` (optional, string): Additional field 2 (max length — site plan limit)
- `other3` (optional, string): Additional field 3 (max length — site plan limit)
- `other4` (optional, string): Additional field 4 (max length — site plan limit)
- `other5` (optional, string): Additional field 5 (max length — site plan limit)
- `author` (optional, string): Existing user nickname. Deprecated — use `author_id`. Available to module administrators and editors only.
- `author_id` (optional, integer): User ID — publish entry on their behalf. Takes priority over `author`. Available to module administrators and editors only.

### `DELETE` `/board/posts` — Delete entry

Delete an entry from the module

**Parameters:**
- `id` (query, required, integer): Entry ID

### `POST` `/board/tags` — Add/update entry tags

Add, change, or remove tags for an entry

**Request body** (`application/x-www-form-urlencoded`):
- `id` (required, integer): Entry ID
- `tags` (optional, string): Comma-separated list of tags

### `GET` `/board/category` — Get category/section list

Get all module categories and sections

**Parameters:**
- `id` (query, optional, integer): ID of a specific category

### `POST` `/board/category` — Add category/section

Add a new category or section

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `name` (required, string): Category/section name
- `description` (optional, string)
- `hgu_title` (optional, string)
- `ownurl` (optional, string): Custom category slug (without domain)
- `position` (optional, integer)
- `access2category` (optional, string): Comma-separated group IDs allowed to view the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2add` (optional, string): Comma-separated group IDs allowed to add entries to the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2page` (optional, string): Comma-separated group IDs allowed to view the category page. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `file` (optional, string(binary)): Category image

### `PUT` `/board/category` — Edit category/section

Edit an existing category or section

**Parameters:**
- `id` (query, required, integer): Category ID

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `name` (optional, string)
- `description` (optional, string)
- `hgu_title` (optional, string)
- `ownurl` (optional, string): Custom category slug (without domain)
- `position` (optional, integer)
- `access2category` (optional, string): Comma-separated group IDs allowed to view the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2add` (optional, string): Comma-separated group IDs allowed to add entries to the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2page` (optional, string): Comma-separated group IDs allowed to view the category page. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `file` (optional, string(binary)): Category image

### `DELETE` `/board/category` — Delete category/section

Delete a category or section

**Parameters:**
- `id` (query, required, integer): Category ID

### `GET` `/board/comments` — Get entry comments

Get all comments for a specific entry

**Parameters:**
- `id` (query, required, integer): Entry ID

### `POST` `/board/comments` — Add comment

Add a comment to an entry

**Request body** (`application/x-www-form-urlencoded`):
- `entry_id` (required, integer): Entry ID
- `message` (required, string): Comment text
- `pros` (optional, string): Entry pros
- `cons` (optional, string): Entry cons
- `parent_id` (optional, integer): Parent comment ID
- `user_id` (optional, integer): User ID on whose behalf the comment is added. Works only when called by a user with permission to edit all comments.
- `subscribe_to_replies` (optional, string): Subscribe the authenticated user to replies for the entry after adding the comment. Value 0/no does not create a subscription; 1/yes creates a subscription. By default, the subscription is created.

### `PUT` `/board/comments` — Edit comment

Edit an existing comment

**Parameters:**
- `id` (query, required, integer): Comment ID

**Request body** (`application/x-www-form-urlencoded`):
- `message` (optional, string)
- `pros` (optional, string): Entry pros
- `cons` (optional, string): Entry cons

### `DELETE` `/board/comments` — Delete comment

**Parameters:**
- `id` (query, required, integer): Comment ID

### `GET` `/board/filter` — Get filter list

Get all module filters

**Parameters:**
- `filter_id` (query, optional, integer): Filter ID

### `POST` `/board/filter` — Add filter

Add a new filter

**Request body** (`application/x-www-form-urlencoded`):
- `filter_num` (required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)
- `name` (required, string): Filter name
- `items` (required, string): Values separated by |
- `multiselect` (optional, string enum[True, False]): Multiple selection (yes/no)
- `multi4userdisabled` (optional, string enum[True, False]): Multiple selection for regular users

### `PUT` `/board/filter` — Update filter

Update an existing filter

**Request body** (`application/x-www-form-urlencoded`):
- `filter_num` (required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)
- `name` (optional, string): New filter name
- `items` (optional, string): New values separated by |
- `multiselect` (optional, string enum[True, False])
- `multi4userdisabled` (optional, string enum[True, False])

### `DELETE` `/board/filter` — Delete filter

Delete a module filter

**Parameters:**
- `filter_num` (query, required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)

### `GET` `/board/fields` — Get module field settings

Shows available module fields

---
## Photo Module

OpenAPI: https://api.ucoz.net/photo-openapi.yaml

| Method | Path | Summary |
|---|---|---|
| `GET` | `/photo` | Search entries |
| `POST` | `/photo` | Add entry |
| `PUT` | `/photo` | Edit entry |
| `GET` | `/photo/album` | Album / category entries |
| `DELETE` | `/photo/entry` | Delete entry |
| `GET` | `/photo/category` | Get category/section list |
| `POST` | `/photo/category` | Add category/section |
| `PUT` | `/photo/category` | Edit category/section |
| `DELETE` | `/photo/category` | Delete category/section |
| `GET` | `/photo/comments` | Get entry comments |
| `POST` | `/photo/comments` | Add comment |
| `PUT` | `/photo/comments` | Edit comment |
| `DELETE` | `/photo/comments` | Delete comment |
| `GET` | `/photo/filter` | Get filter list |
| `POST` | `/photo/filter` | Add filter |
| `PUT` | `/photo/filter` | Update filter |
| `DELETE` | `/photo/filter` | Delete filter |
| `GET` | `/photo/fields` | Get module field settings |

### `GET` `/photo` — Search entries

Get a specific entry by ID. **Notes:** - If no entries are found, you receive `{"error":{"msg":"Nothing found for your request"}}`

**Parameters:**
- `id` (query, optional, integer): Entry ID

### `POST` `/photo` — Add entry

Add a new entry to the "Photo album" module

**Request body** (`multipart/form-data`):
- `category` (required, integer): Category ID
- `photo` (required, string(binary)): Image (file)
- `name` (optional, string): Photo title
- `description` (optional, string): Entry description
- `ownurl` (optional, string): Entry custom URL (SEO-friendly)
- `other1` (optional, string): Additional field 1
- `other2` (optional, string): Additional field 2
- `other3` (optional, string): Additional field 3
- `other4` (optional, string): Additional field 4
- `other5` (optional, string): Additional field 5
- `author` (optional, string): Existing user nickname. Deprecated — use `author_id`. Available to module administrators and editors only.
- `author_id` (optional, integer): User ID — publish photo on their behalf. Takes priority over `author`. Available to module administrators and editors only.
- `tags` (optional, string): Entry tags, comma-separated (tag1,tag2,tag3)
- `comments` (optional, integer enum[1, 0]): Allow comments. Default — enabled. Legacy `yes`/`no` values are also supported
- `pending` (optional, integer enum[1, 0]): Put the entry into pending activation (premoderation). Default — disabled. Legacy `yes`/`no` values are also supported
- `subscribe` (optional, integer enum[1, 0]): Subscribe to entry comments. Default — disabled. Legacy `yes`/`no` values are also supported
- `filter1` (optional, string): Filter 1 values — comma-separated value IDs (see `GET /photo/filter`)
- `filter2` (optional, string): Filter 2 values — comma-separated value IDs (see `GET /photo/filter`)
- `img1_title` (optional, string): Image title (if enabled in module settings)
- `img1_alt` (optional, string): Image alt (if enabled in module settings)
- `save_original` (optional, integer enum[1, 0]): Keep the original image. Default — disabled. Legacy `yes`/`no` values are also supported
- `add_date` (optional, string): Entry publication date and time. Format: `YYYY-MM-DD HH:MM`. Works only if the module thin settings option “Enable the ability to choose the entry add date” is enabled.

### `PUT` `/photo` — Edit entry

Edit existing entry

**Request body** (`multipart/form-data`):
- `id` (required, integer): Entry ID (required)
- `category` (optional, integer): Category ID
- `photo` (optional, string(binary)): Image (file)
- `name` (optional, string): Photo title
- `description` (optional, string): Entry description
- `ownurl` (optional, string): Entry custom URL (SEO-friendly)
- `other1` (optional, string): Additional field 1
- `other2` (optional, string): Additional field 2
- `other3` (optional, string): Additional field 3
- `other4` (optional, string): Additional field 4
- `other5` (optional, string): Additional field 5
- `author` (optional, string): Existing user nickname. Deprecated — use `author_id`. Available to module administrators and editors only.
- `author_id` (optional, integer): User ID — republish photo on their behalf. Takes priority over `author`. Available to module administrators and editors only.
- `comments` (optional, integer enum[1, 0]): Allow comments. Default — enabled. Legacy `yes`/`no` values are also supported
- `pending` (optional, integer enum[1, 0]): Put the entry into pending activation (premoderation). Default — disabled. Legacy `yes`/`no` values are also supported
- `subscribe` (optional, integer enum[1, 0]): Subscribe to entry comments. Default — disabled. Legacy `yes`/`no` values are also supported
- `filter1` (optional, string): Filter 1 values — comma-separated value IDs (see `GET /photo/filter`)
- `filter2` (optional, string): Filter 2 values — comma-separated value IDs (see `GET /photo/filter`)
- `img1_title` (optional, string): Image title (if enabled in module settings)
- `img1_alt` (optional, string): Image alt (if enabled in module settings)
- `save_original` (optional, integer enum[1, 0]): Keep the original image. Default — disabled. Legacy `yes`/`no` values are also supported
- `add_date` (optional, string): Entry publication date and time. Format: `YYYY-MM-DD HH:MM`. Works only if the module thin settings option “Enable the ability to choose the entry add date” is enabled.
- `update_date` (optional, integer enum[0, 1]): 1 — write the current server time into the entry modification date. 0 or omitted — leave the modification date unchanged even if the entry was edited. Despite the name, an arbitrary date cannot be set with this parameter — it is a 0/1 flag. The parameter only works for users with full edit rights for the module; for everyone else it is silently ignored. The result appears in the `mod_date` / `mod…

### `GET` `/photo/album` — Album / category entries

Get album entries. Without `category` — all entries; with `category` — entries in that category only. **Notes:** - To fetch entries from page 2, add parameter `page=N` (N — page number) - If no entries are found, you receive `{"error":{"msg":"Nothing found for your request"}}`

**Parameters:**
- `category` (query, optional, integer): Category ID. If set — returns entries in that category only
- `page` (query, optional, integer): Page number

### `DELETE` `/photo/entry` — Delete entry

Delete entry from module

**Parameters:**
- `id` (query, required, integer): Entry ID

### `GET` `/photo/category` — Get category/section list

Get all module categories and sections

**Parameters:**
- `id` (query, optional, integer): ID of a specific category

### `POST` `/photo/category` — Add category/section

Add new category or section

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `name` (required, string): Category/section name
- `description` (optional, string)
- `hgu_title` (optional, string)
- `ownurl` (optional, string): Custom category slug (without domain)
- `position` (optional, integer)
- `access2category` (optional, string): Comma-separated group IDs allowed to view the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2add` (optional, string): Comma-separated group IDs allowed to add entries to the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2page` (optional, string): Comma-separated group IDs allowed to view the category page. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `file` (optional, string(binary)): Category image

### `PUT` `/photo/category` — Edit category/section

Edit existing category or section

**Parameters:**
- `id` (query, required, integer): Category ID

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `name` (optional, string)
- `description` (optional, string)
- `hgu_title` (optional, string)
- `ownurl` (optional, string): Custom category slug (without domain)
- `position` (optional, integer)
- `access2category` (optional, string): Comma-separated group IDs allowed to view the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2add` (optional, string): Comma-separated group IDs allowed to add entries to the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2page` (optional, string): Comma-separated group IDs allowed to view the category page. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `file` (optional, string(binary)): Category image

### `DELETE` `/photo/category` — Delete category/section

Delete category or section

**Parameters:**
- `id` (query, required, integer): Category ID

### `GET` `/photo/comments` — Get entry comments

Get all comments for a specific entry

**Parameters:**
- `id` (query, required, integer): Entry ID

### `POST` `/photo/comments` — Add comment

Add comment to entry

**Request body** (`application/x-www-form-urlencoded`):
- `entry_id` (required, integer): Entry ID
- `message` (required, string): Comment text
- `pros` (optional, string): Entry pros
- `cons` (optional, string): Entry cons
- `parent_id` (optional, integer): Parent comment ID
- `user_id` (optional, integer): User ID on whose behalf the comment is added. Works only when called by a user with permission to edit all comments.
- `subscribe_to_replies` (optional, string): Subscribe the authenticated user to replies for the entry after adding the comment. Value 0/no does not create a subscription; 1/yes creates a subscription. By default, the subscription is created.

### `PUT` `/photo/comments` — Edit comment

Edit existing comment

**Parameters:**
- `id` (query, required, integer): Comment ID

**Request body** (`application/x-www-form-urlencoded`):
- `message` (optional, string)
- `pros` (optional, string): Entry pros
- `cons` (optional, string): Entry cons

### `DELETE` `/photo/comments` — Delete comment

**Parameters:**
- `id` (query, required, integer): Comment ID

### `GET` `/photo/filter` — Get filter list

Get all module filters

**Parameters:**
- `filter_id` (query, optional, integer): Filter ID

### `POST` `/photo/filter` — Add filter

Add new filter

**Request body** (`application/x-www-form-urlencoded`):
- `filter_num` (required, integer enum[1, 2]): Filter number (1 or 2)
- `name` (required, string): Filter name
- `items` (required, string): Values separated by |
- `multiselect` (optional, string enum[True, False]): Multiple selection (yes/no)
- `multi4userdisabled` (optional, string enum[True, False]): Disable multiple selection for regular users (yes/no)

### `PUT` `/photo/filter` — Update filter

Update existing filter

**Request body** (`application/x-www-form-urlencoded`):
- `filter_num` (required, integer enum[1, 2]): Filter number (1 or 2)
- `name` (optional, string): New filter name
- `items` (optional, string): New values separated by |
- `multiselect` (optional, string enum[True, False])
- `multi4userdisabled` (optional, string enum[True, False])

### `DELETE` `/photo/filter` — Delete filter

Delete module filter

**Parameters:**
- `filter_num` (query, required, integer enum[1, 2]): Filter number (1 or 2)

### `GET` `/photo/fields` — Get module field settings

Shows available module fields

---
## Video Module

OpenAPI: https://api.ucoz.net/video-openapi.yaml

| Method | Path | Summary |
|---|---|---|
| `GET` | `/video` | Get all module entries |
| `POST` | `/video` | Add video |
| `PUT` | `/video` | Edit video |
| `DELETE` | `/video/posts` | Delete video |
| `GET` | `/video/category` | Get entry category list |
| `POST` | `/video/category` | Add entry category |
| `PUT` | `/video/category` | Update entry category |
| `DELETE` | `/video/category` | Delete entry category |
| `GET` | `/video/channel` | Get channel list |
| `POST` | `/video/channel` | Add channel |
| `PUT` | `/video/channel` | Update channel |
| `DELETE` | `/video/channel` | Delete channel |
| `GET` | `/video/channel/category` | Get channel category list |
| `POST` | `/video/channel/category` | Add channel category |
| `PUT` | `/video/channel/category` | Update channel category |
| `DELETE` | `/video/channel/category` | Delete channel category |
| `GET` | `/video/comments` | Get comments |
| `POST` | `/video/comments` | Add comment |
| `DELETE` | `/video/comments` | Delete comment |
| `GET` | `/video/filter` | Get filter list |
| `POST` | `/video/filter` | Add filter |
| `PUT` | `/video/filter` | Update filter |
| `DELETE` | `/video/filter` | Delete filter |

### `GET` `/video` — Get all module entries

Get all video entries in the module

**Parameters:**
- `page` (query, optional, integer): Page number.
- `per_page` (query, optional, integer): Entries per page.
- `sort` (query, optional, string): Sort type

### `POST` `/video` — Add video

Add a new video to the module

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `category` (required, integer): Category ID
- `title` (required, string): Video title
- `description` (required, string): Video description
- `object` (required, string): Video embed code (e.g. `<iframe>`). Alias — `embobject`. In read responses it is returned in the `embobject` field.
- `name` (optional, string): Display name of the video author (not to be confused with `author` — a user nickname)
- `author` (optional, string): Nickname of an existing user. Deprecated — use `author_id`. Available only to module administrators and editors.
- `author_id` (optional, integer): User ID — publish the video on behalf of this user. Takes precedence over `author`. Available only to module administrators and editors.
- `author_email` (optional, string(email)): Author email
- `author_site` (optional, string(uri)): Author website
- `genre` (optional, string): Genre
- `duration` (optional, string): Duration as `HH:MM:SS` or `MM:SS`. Invalid format — `INVALID_DATETIME`
- `language` (optional, string): Interface language from the module list. Unknown value — `EXCLUSIVE_DATA_RANGE`
- `year` (optional, string): Year
- `acters` (optional, string): Actors
- `producer` (optional, string): Director
- `quality` (optional, string): Video quality
- `comments` (optional, integer enum[1, 0]): Allow comments. Default — enabled. Legacy `yes`/`no` values are also supported
- `ontop` (optional, integer enum[1, 0]): Pin the entry at the top. Default — disabled. Legacy `yes`/`no` values are also supported
- `pending` (optional, integer enum[1, 0]): Put into pending activation (premoderation). Default — disabled. Legacy `yes`/`no` values are also supported
- `subscribe` (optional, integer enum[1, 0]): Subscribe to entry comments. Default — disabled. Legacy `yes`/`no` values are also supported
- `screenshot1` (optional, string(binary)): Video screenshot (preview) — slots `screenshot1`, `screenshot2`, … up to the module settings limit. Sent only in `multipart/form-data`. Uploaded images are returned in the `files` array of responses.
- `screenshot_url1` (optional, string): Screenshot by URL — slots `screenshot_url1`, `screenshot_url2`, … (an alternative to uploading `screenshot1`).
- `meta_title` (optional, string): Meta Title
- `meta_description` (optional, string): Meta Description
- `hgu_title` (optional, string): Entry SEO-friendly URL
- `ownurl` (optional, string): Custom entry URL (SEO-friendly)
- `tags` (optional, string): Tags, comma-separated
- `other1` (optional, string): Additional field 1
- `other2` (optional, string): Additional field 2
- `other3` (optional, string): Additional field 3
- `other4` (optional, string): Additional field 4
- `other5` (optional, string): Additional field 5
- `add_date` (optional, string): Publication date and time as `YYYY-MM-DD HH:MM`. Works if the add-date option is enabled in module settings.

### `PUT` `/video` — Edit video

Edit existing video

**Parameters:**
- `id` (query, required, integer): Video ID

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `category` (optional, integer): Category ID
- `title` (optional, string): Video title
- `description` (optional, string): Video description
- `object` (optional, string): Video embed code. In read responses it is returned in the `embobject` field
- `embobject` (optional, string): Legacy alias for `object` (kept for backward compatibility)
- `name` (optional, string): Display name of the video author
- `author` (optional, string): Nickname of an existing user. Deprecated — use `author_id`. Available only to module administrators and editors.
- `author_id` (optional, integer): User ID — republish the video on behalf of this user. Takes precedence over `author`. Available only to module administrators and editors.
- `author_email` (optional, string(email)): Author email
- `author_site` (optional, string(uri)): Author website
- `genre` (optional, string): Genre
- `duration` (optional, string): Duration as `HH:MM:SS` or `MM:SS`
- `language` (optional, string): Interface language from the module list
- `year` (optional, string): Year
- `acters` (optional, string): Actors
- `producer` (optional, string): Director
- `quality` (optional, string): Video quality
- `comments` (optional, integer enum[1, 0]): Allow comments. Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `ontop` (optional, integer enum[1, 0]): Pin the entry at the top. Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `pending` (optional, integer enum[1, 0]): Pending activation (premoderation). Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `subscribe` (optional, integer enum[1, 0]): Subscription to comments. Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `screen1` (optional, string(binary)): Video screenshot (preview) — slots `screen1`, `screen2`, … Sent only in `multipart/form-data`. PATCH semantics: a slot without a value keeps the current screenshot.
- `screen_url1` (optional, string): Screenshot by URL — slots `screen_url1`, `screen_url2`, …
- `del_scr0` (optional, integer enum[0, 1]): 1 — remove the screenshot in slot 0 (0-based; same for `del_scr1`, `del_scr2`, …)
- `meta_title` (optional, string): Meta Title
- `meta_description` (optional, string): Meta Description
- `hgu_title` (optional, string): Entry SEO-friendly URL
- `ownurl` (optional, string): Custom entry URL (SEO-friendly)
- `other1` (optional, string)
- `other2` (optional, string)
- `other3` (optional, string)
- `other4` (optional, string)
- `other5` (optional, string)
- `add_date` (optional, string): Publication date and time as `YYYY-MM-DD HH:MM`. Works if the add-date option is enabled in module settings.
- `update_lastmod` (optional, integer enum[0, 1]): 1 — write the current server time into the entry modification date. 0 or omitted — leave the modification date unchanged even if the entry was edited. An arbitrary date cannot be set with this field. The parameter only works for users with full edit rights for the module; for everyone else it is silently ignored. Regardless of this parameter, the modification date is updated automatically once mo…

### `DELETE` `/video/posts` — Delete video

Delete video from module

**Parameters:**
- `id` (query, required, integer): Video ID

### `GET` `/video/category` — Get entry category list

Get all video entry categories

**Parameters:**
- `id` (query, optional, integer): ID of a specific category

### `POST` `/video/category` — Add entry category

Add a new video entry category

**Request body** (`application/x-www-form-urlencoded`):
- `name` (required, string): Category name
- `parent_id` (optional, integer): Parent category ID
- `hgu_title` (optional, string): Category SEO-friendly URL
- `description` (optional, string): Category description

### `PUT` `/video/category` — Update entry category

Update existing video entry category

**Parameters:**
- `id` (query, required, integer): Category ID

**Request body** (`application/x-www-form-urlencoded`):
- `name` (optional, string): New category name
- `parent_id` (optional, integer): Parent category ID
- `hgu_title` (optional, string): New category SEO-friendly URL
- `description` (optional, string): New category description

### `DELETE` `/video/category` — Delete entry category

Delete video entry category

**Parameters:**
- `id` (query, required, integer): Category ID

### `GET` `/video/channel` — Get channel list

Get all module channels

**Parameters:**
- `channel_id` (query, optional, integer): Specific channel ID

### `POST` `/video/channel` — Add channel

Add a new channel

**Request body** (`application/x-www-form-urlencoded`):
- `name` (required, string): Channel name
- `category` (required, integer): Channel category ID. Must be a valid existing channel category ID (on staging `category=1` returns NOT_FOUND, `category=0` works).
- `description` (optional, string): Channel description

### `PUT` `/video/channel` — Update channel

Update an existing channel. If you pass `category`, use a valid channel category ID (on staging `category=1` returns NOT_FOUND, `category=0` works).

**Parameters:**
- `id` (query, required, integer): Channel ID

**Request body** (`application/x-www-form-urlencoded`):
- `name` (optional, string): New channel name
- `category` (optional, integer): Valid channel category ID
- `description` (optional, string): New channel description

### `DELETE` `/video/channel` — Delete channel

**Parameters:**
- `id` (query, required, integer): Channel ID

### `GET` `/video/channel/category` — Get channel category list

Get all module channel categories. If `id` is passed, returns a specific category.

**Parameters:**
- `id` (query, optional, integer): Specific channel category ID

### `POST` `/video/channel/category` — Add channel category

Add a new channel category

**Request body** (`application/x-www-form-urlencoded`):
- `name` (required, string): Category name
- `parent_id` (optional, integer): Parent category ID
- `hgu_title` (optional, string): Category SEO-friendly URL

### `PUT` `/video/channel/category` — Update channel category

Update existing channel category

**Parameters:**
- `id` (query, required, integer): Channel category ID

**Request body** (`application/x-www-form-urlencoded`):
- `name` (optional, string): New category name
- `parent_id` (optional, integer): Parent category ID
- `hgu_title` (optional, string): New category SEO-friendly URL

### `DELETE` `/video/channel/category` — Delete channel category

**Parameters:**
- `id` (query, required, integer): Channel category ID

### `GET` `/video/comments` — Get comments

Get comments for a video or channel. Use `id` for video comments or `channel_id` for channel comments.

**Parameters:**
- `id` (query, optional, integer): Video ID
- `channel_id` (query, optional, integer): Channel ID

### `POST` `/video/comments` — Add comment

Add a comment to a video or channel. For video pass `entry_id`; for channel pass `channel_id`.

**Request body** (`application/x-www-form-urlencoded`):
- `entry_id` (optional, integer): Video ID
- `channel_id` (optional, integer): Channel ID
- `message` (required, string): Comment text
- `pros` (optional, string): Entry pros
- `cons` (optional, string): Entry cons
- `parent_id` (optional, integer): Parent comment ID
- `user_id` (optional, integer): User ID on whose behalf the comment is added. Works only when called by a user with permission to edit all comments.
- `subscribe_to_replies` (optional, string): Subscribe the authenticated user to replies for the entry after adding the comment. Value 0/no does not create a subscription; 1/yes creates a subscription. By default, the subscription is created.

### `DELETE` `/video/comments` — Delete comment

Delete comment by ID

**Parameters:**
- `id` (query, required, integer): Comment ID

### `GET` `/video/filter` — Get filter list

Get all module filters

**Parameters:**
- `filter_id` (query, optional, integer): Filter ID

### `POST` `/video/filter` — Add filter

Add new filter

**Request body** (`application/x-www-form-urlencoded`):
- `filter_num` (required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)
- `name` (required, string): Filter name
- `items` (required, string): Values separated by |
- `multiselect` (optional, string enum[True, False]): Multiple selection (yes/no)
- `multi4userdisabled` (optional, string enum[True, False]): Disable multiple selection for regular users (yes/no)

### `PUT` `/video/filter` — Update filter

Update existing filter

**Request body** (`application/x-www-form-urlencoded`):
- `filter_num` (required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)
- `name` (optional, string): New filter name
- `items` (optional, string): New values separated by |
- `multiselect` (optional, string enum[True, False])
- `multi4userdisabled` (optional, string enum[True, False])

### `DELETE` `/video/filter` — Delete filter

Delete module filter

**Parameters:**
- `filter_num` (query, required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)

---
## FAQ Module

OpenAPI: https://api.ucoz.net/faq-openapi.yaml

| Method | Path | Summary |
|---|---|---|
| `GET` | `/faq` | Get all module entries |
| `POST` | `/faq` | Add Q&A entry |
| `PUT` | `/faq` | Update Q&A entry |
| `DELETE` | `/faq/posts` | Delete Q&A entry |
| `GET` | `/faq/category` | Get category list |
| `POST` | `/faq/category` | Add category |
| `PUT` | `/faq/category` | Update category |
| `DELETE` | `/faq/category` | Delete category |
| `GET` | `/faq/fields` | Get module field settings |

### `GET` `/faq` — Get all module entries

Get a list of all Q&A entries in the FAQ module

**Parameters:**
- `page` (query, optional, integer): Page number.
- `per_page` (query, optional, integer): Number of entries per page.
- `id` (query, optional, integer): ID of a specific entry
- `category` (query, optional, integer): Category ID

### `POST` `/faq` — Add Q&A entry

Add a new Q&A entry to the FAQ module

**Request body** (`application/x-www-form-urlencoded`):
- `category` (required, integer): Category ID (required)
- `subject` (required, string): Question subject
- `question` (required, string): Question text
- `answer` (required, string): Answer text
- `ontop` (optional, string enum[True, False]): Always show on top?
- `other1` (optional, string)
- `other2` (optional, string)
- `other3` (optional, string)
- `other4` (optional, string)
- `other5` (optional, string)
- `author` (optional, string): Nickname of an existing user. Deprecated — use `author_id`. Available only to module administrators and editors.
- `author_id` (optional, integer): User ID — publish the entry on behalf of this user. Takes precedence over `author`. Available only to module administrators and editors.
- `tags` (optional, string): Entry tags, comma-separated (tag1,tag2,tag3)

### `PUT` `/faq` — Update Q&A entry

Update an existing Q&A entry

**Parameters:**
- `id` (query, required, integer): Entry ID

**Request body** (`application/x-www-form-urlencoded`):
- `question` (optional, string)
- `answer` (optional, string)
- `ontop` (optional, string enum[True, False])
- `hgu_title` (optional, string)
- `other1` (optional, string)
- `other2` (optional, string)
- `other3` (optional, string)
- `other4` (optional, string)
- `other5` (optional, string)
- `author` (optional, string): Nickname of an existing user. Deprecated — use `author_id`. Available only to module administrators and editors.
- `author_id` (optional, integer): User ID — republish the entry on behalf of this user. Takes precedence over `author`. Available only to module administrators and editors.

### `DELETE` `/faq/posts` — Delete Q&A entry

Delete a Q&A entry from the module

**Parameters:**
- `id` (query, required, integer): Entry ID

### `GET` `/faq/category` — Get category list

Get all categories in the FAQ module

**Parameters:**
- `id` (query, optional, integer): ID of a specific category

### `POST` `/faq/category` — Add category

Add a new category

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `name` (required, string): Category name
- `description` (optional, string)
- `hgu_title` (optional, string)
- `ownurl` (optional, string): Custom category slug (without domain)
- `position` (optional, integer)
- `file` (optional, string(binary)): Category image

### `PUT` `/faq/category` — Update category

Update an existing category

**Parameters:**
- `id` (query, required, integer): Category ID

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `name` (optional, string)
- `description` (optional, string)
- `hgu_title` (optional, string)
- `ownurl` (optional, string): Custom category slug (without domain)
- `position` (optional, integer)
- `file` (optional, string(binary)): Category image

### `DELETE` `/faq/category` — Delete category

Delete a category

**Parameters:**
- `id` (query, required, integer): Category ID

### `GET` `/faq/fields` — Get module field settings

Returns available module fields

---
## Forum Module

OpenAPI: https://api.ucoz.net/forum-openapi.yaml

**Tags:**
- `Forums`: Forums and subforums
- `Sections`: Forum sections
- `Topics`: Topics (not polls)
- `Posts`: Posts in a topic
- `Polls`: Polls
- `Moderator tools`: Additional path segments after `/topic`, `/posts` or `/poll`

| Method | Path | Summary |
|---|---|---|
| `GET` | `/forum` | Get list of sections and forums |
| `POST` | `/forum` | Create a forum or subforum |
| `PUT` | `/forum` | Update a forum or subforum |
| `DELETE` | `/forum` | Delete a forum or subforum |
| `GET` | `/forum/section` | Get a list of sections or one section |
| `POST` | `/forum/section` | Create a forum section |
| `PUT` | `/forum/section` | Update a forum section |
| `DELETE` | `/forum/section` | Delete a forum section |
| `GET` | `/forum/topic` | Get list of topics or one topic |
| `POST` | `/forum/topic` | Create topic |
| `PUT` | `/forum/topic` | Edit topic / move |
| `DELETE` | `/forum/topic` | Delete topic |
| `POST` | `/forum/topic/move` | Move topic |
| `POST` | `/forum/topic/close` | Close topic |
| `POST` | `/forum/topic/open` | Open topic |
| `POST` | `/forum/topic/ontop` | Pin topic |
| `POST` | `/forum/topic/untop` | Unpin topic |
| `POST` | `/forum/topic/join` | Merge topics |
| `POST` | `/forum/topic/split` | Split topic |
| `POST` | `/forum/topic/subscribe` | Subscribe to topic |
| `POST` | `/forum/topic/unsubscribe` | Unsubscribe from topic |
| `GET` | `/forum/posts` | Get topic posts or one post |
| `POST` | `/forum/posts` | Add post |
| `PUT` | `/forum/posts` | Edit post |
| `DELETE` | `/forum/posts` | Delete post |
| `POST` | `/forum/posts/move` | Move posts |
| `POST` | `/forum/posts/ontop` | Pin topic first post |
| `POST` | `/forum/posts/down` | Unpin topic first post |
| `GET` | `/forum/poll` | Get list of polls or one poll |
| `POST` | `/forum/poll` | Create poll |
| `PUT` | `/forum/poll` | Edit poll |
| `DELETE` | `/forum/poll` | Delete poll (poll topic) |
| `POST` | `/forum/poll/move` | Move poll |
| `POST` | `/forum/poll/close` | Close poll |
| `POST` | `/forum/poll/open` | Open poll |
| `POST` | `/forum/poll/ontop` | Pin poll |
| `POST` | `/forum/poll/untop` | Unpin poll |
| `POST` | `/forum/poll/join` | Merge polls |
| `POST` | `/forum/poll/split` | Split poll |
| `POST` | `/forum/poll/subscribe` | Subscribe to poll |
| `GET` | `/forum/poll/results` | Poll results |
| `POST` | `/forum/poll/vote` | Vote in poll |

### `GET` `/forum` — Get list of sections and forums

Returns an object with a `sections` array (not flat `forums` + `topics`).

**Parameters:**
- `id` (query, optional, integer): Filter by forum ID (optional)

### `POST` `/forum` — Create a forum or subforum

Available to the site administrator or API owner. To create a top-level forum, pass `section_id`. To create a subforum, pass `parent_forum_id` — the ID of a top-level forum. The `section_id` and `parent_forum_id` parameters are mutually exclusive. Subforums cannot be nested more than one level deep.

**Request body** (`application/x-www-form-urlencoded`):
- `section_id` (optional, integer): Section ID for a top-level forum
- `parent_forum_id` (optional, integer): Top-level forum ID for a new subforum
- `name` (optional, string)
- `description` (optional, string)
- `state` (optional, integer enum[1, 2, 3]): 1 — active, 2 — closed, 3 — hidden Default: `1`.
- `moderators` (optional, string): Moderator usernames separated by commas
- `may_read` (optional, object): Map of allowed user groups; keys are group identifiers
- `may_add_threads` (optional, object): Map of allowed user groups; keys are group identifiers
- `may_add_answers` (optional, object): Map of allowed user groups; keys are group identifiers
- `custom_settings` (optional, integer enum[0, 1])
- `password` (optional, string): Private forum password; Latin letters and digits only
- `link2newmsg_icon` (optional, string)
- `link2nomsg_icon` (optional, string)
- `does_not_affect_user_counters` (optional, integer enum[0, 1])
- `no_feed` (optional, integer enum[0, 1])
- `rules_caption` (optional, string)
- `rules_description` (optional, string)
- `meta_title` (optional, string): SEO title
- `meta_description` (optional, string): SEO description
- `meta_keywords` (optional, string): SEO keywords

### `PUT` `/forum` — Update a forum or subforum

Available to the site administrator or API owner. The request body must contain `forum_id` (the `id` alias is also accepted). To move a top-level forum to another section, pass `section_id`. To move a forum under a parent forum, pass `parent_forum_id` — the parent must be a top-level forum. Do not pass `section_id` and `parent_forum_id` together. A forum with subforums cannot be moved to another level; such a request returns `409 CONFLICT`.

**Request body** (`application/x-www-form-urlencoded`):
- `section_id` (optional, integer): Section ID for a top-level forum
- `parent_forum_id` (optional, integer): Top-level forum ID for a new subforum
- `name` (optional, string)
- `description` (optional, string)
- `state` (optional, integer enum[1, 2, 3]): 1 — active, 2 — closed, 3 — hidden Default: `1`.
- `moderators` (optional, string): Moderator usernames separated by commas
- `may_read` (optional, object): Map of allowed user groups; keys are group identifiers
- `may_add_threads` (optional, object): Map of allowed user groups; keys are group identifiers
- `may_add_answers` (optional, object): Map of allowed user groups; keys are group identifiers
- `custom_settings` (optional, integer enum[0, 1])
- `password` (optional, string): Private forum password; Latin letters and digits only
- `link2newmsg_icon` (optional, string)
- `link2nomsg_icon` (optional, string)
- `does_not_affect_user_counters` (optional, integer enum[0, 1])
- `no_feed` (optional, integer enum[0, 1])
- `rules_caption` (optional, string)
- `rules_description` (optional, string)
- `meta_title` (optional, string): SEO title
- `meta_description` (optional, string): SEO description
- `meta_keywords` (optional, string): SEO keywords
- `forum_id` (required, integer): ID of the forum or subforum to update (also accepts `id`)

### `DELETE` `/forum` — Delete a forum or subforum

Available to the site administrator or API owner. A forum can be deleted only when it has no subforums and no topics. If the forum contains subforums or topics, the API returns `409 CONFLICT`.

**Parameters:**
- `forum_id` (query, required, integer): ID of the forum or subforum to delete (also accepts `id`)

### `GET` `/forum/section` — Get a list of sections or one section

Returns the forum section list. If `section_id` is provided, returns one section. SEO metadata fields (`meta_title`, `meta_description`, `meta_keywords`) are returned to the site administrator or API owner.

**Parameters:**
- `section_id` (query, optional, integer): Section ID for retrieving one section (also accepts `id`)

### `POST` `/forum/section` — Create a forum section

Available to the site administrator or API owner.

**Request body** (`application/x-www-form-urlencoded`):
- `name` (optional, string)
- `icon` (optional, string): Section icon (also accepts `ico`)
- `rules` (optional, string): Section rules text
- `rules_name` (optional, string): Section rules title
- `meta_title` (optional, string): SEO title
- `meta_description` (optional, string): SEO description
- `meta_keywords` (optional, string): SEO keywords

### `PUT` `/forum/section` — Update a forum section

Available to the site administrator or API owner. The request body must contain `section_id` (the `id` alias is also accepted).

**Request body** (`application/x-www-form-urlencoded`):
- `name` (optional, string)
- `icon` (optional, string): Section icon (also accepts `ico`)
- `rules` (optional, string): Section rules text
- `rules_name` (optional, string): Section rules title
- `meta_title` (optional, string): SEO title
- `meta_description` (optional, string): SEO description
- `meta_keywords` (optional, string): SEO keywords
- `section_id` (required, integer): ID of the section to update (also accepts `id`)
- `order` (optional, integer): Section order

### `DELETE` `/forum/section` — Delete a forum section

Available to the site administrator or API owner. A section can be deleted only when it contains no forums. If the section contains forums, the API returns `409 CONFLICT`.

**Parameters:**
- `section_id` (query, required, integer): ID of the section to delete (also accepts `id`)

### `GET` `/forum/topic` — Get list of topics or one topic

**Parameters:**
- `forum_id` (query, optional, integer): Forum ID (also accepts `fid`)
- `topic_id` (query, optional, integer): Topic ID (also accepts `id`)
- `page` (query, optional, integer): Request page. Applies to list requests (topics, posts, polls — including filtering by forum); ignored when requesting a specific object by its ID
- `per_page` (query, optional, integer): Objects per request (list page size). Applies to list requests; ignored when requesting a specific object by its ID
- `password` (query, optional, string): Private forum password

### `POST` `/forum/topic` — Create topic

Forum identifier is required: `id`, `fid` or `forum_id`. Successful response — created topic (first post) object: `id` — new topic ID, `message` — processed text, `original_message` — original text before parsing (if applicable). When creating a poll (`POST /forum/poll`), poll fields may additionally be returned in the same format. For migration/import scenarios, pass `add_date` to preserve the original topic and first post creation time. Accepted format is `YYYY-MM-DD HH:MM` or `YYYY-MM-DD` in the site's local time. Date and time parts are validated; dates later than current server time plus 24 hours and invalid values return `INVALID_DATETIME`. The stored time affects topic/post chronological ordering. To attach files or images to the first post of the topic, send the request as `multip…

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `id` (optional, integer): ID of the forum board where the topic is created (or `fid` / `forum_id`). Required — `MISSING_REQ_PARAM` otherwise
- `fid` (optional, integer): Forum ID synonym
- `forum_id` (optional, integer): Forum ID synonym
- `name` (required, string): Topic title. Required; up to 70 characters — `MAX_LENGTH_REACHED` when exceeded
- `description` (optional, string): Topic description. Up to 70 characters — `MAX_LENGTH_REACHED` when exceeded
- `message` (required, string): First post text (topic body), required. The maximum length is set by the module setting "Maximum message length"; `MAX_LENGTH_REACHED` when exceeded
- `author` (optional, string): Existing user nickname — publish topic on their behalf. Value `-1` switches first post to wiki-bot mode (if enabled and allowed for group). Available to forum moderators only. Deprecated: use `author_id`.
- `author_id` (optional, integer): Numeric user ID — publish topic on their behalf. Takes priority over `author` when both are passed. Non-existing user — `USER_NOT_FOUND`. Available to forum moderators only. Used only for topic creation; to reply in an existing topic see `user_id` in `POST /forum/posts`.
- `add_date` (optional, string): Creation date/time for topic migration. Format: `YYYY-MM-DD HH:MM` or `YYYY-MM-DD`, in the site's local time. Year must produce a positive Unix timestamp, month/day/hour/minute must form a real date and time, and the value must not be later than current server time plus 24 hours; invalid values return `INVALID_DATETIME`.
- `includehtml` (optional, integer enum[1, 0]): Allow HTML in the message text. Default (when omitted) — enabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `end2br` (optional, integer enum[1, 0]): Convert line breaks to `<br />`. Default — enabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `smiles` (optional, integer enum[1, 0]): Smileys in the message. Default — enabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `signature` (optional, integer enum[1, 0]): Signature under the message. Default — enabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `firstontop` (optional, integer enum[1, 0]): Pin the first post at the top of the topic (if allowed for group). Default — disabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `ontop` (optional, integer enum[1, 0]): Pin the topic at the top of the list (if allowed for group). Default — disabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `closed` (optional, integer enum[1, 0]): Create the topic closed (if allowed for group). Default — disabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `password` (optional, string): Private forum password — required if the forum is private and the group has no bypass right (`FORBIDDEN`)
- `file1` (optional, string(binary)): Attached file or image in slot `file1`. Pass `file2`, `file3`, ... the same way up to the forum settings limit. Available only in `multipart/form-data`; uploaded attachments are returned in the response `files` array when the method returns file information.

### `PUT` `/forum/topic` — Edit topic / move

Change title/description and/or move to forum `nfid` / `newforum_id`. Response returns current record state: for a regular topic — topic object, for a poll (`poll=1`) — poll object (as in `GET /forum/poll` with `id`). To edit attachments of the first post, send the request as `multipart/form-data`: new files are passed in `file1`, `file2`, ...; existing attachments are removed with `del_img1=1`, `del_img2=1`, ... .

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `tid` (optional, integer)
- `id` (optional, integer)
- `topic_id` (optional, integer)
- `name` (optional, string)
- `description` (optional, string)
- `nfid` (optional, integer)
- `newforum_id` (optional, integer)
- `author` (optional, string): Existing user nickname — reassign topic author. Value `-1` switches first post to wiki-bot mode (if enabled and allowed for group). Available to forum moderators only. Deprecated: use `author_id`.
- `author_id` (optional, integer): Numeric user ID — reassign topic author. Takes priority over `author` when both are passed. Available to forum moderators only.
- `file1` (optional, string(binary)): Attached file or image in slot `file1`. Pass `file2`, `file3`, ... the same way up to the forum settings limit. Available only in `multipart/form-data`; uploaded attachments are returned in the response `files` array when the method returns file information.
- `del_img1` (optional, integer enum[0, 1]): 1 — remove the attachment in slot 1. Same for `del_img2`, `del_img3`, ...

### `DELETE` `/forum/topic` — Delete topic

Deletes the topic together with all its posts. Equivalent to `DELETE /forum/poll` for poll topics. Also accepts `tid` or `id` instead of `topic_id`.

**Parameters:**
- `topic_id` (query, required, integer): Topic ID

### `POST` `/forum/topic/move` — Move topic

Moves the topic to another forum section `nfid`; when `name` / `description` are specified, the topic title and description are updated at the same time. Source and destination section counters are recalculated; the topic author (if not the move initiator) receives a notification. If `nfid` is not passed and only `name` and/or `description` are set, the operation reduces to renaming the topic without changing section. **Limits**: - `name` — no longer than 63 characters (otherwise previous value is kept); - `description` — no longer than 63 characters (otherwise previous value is kept); - `nfid` must exist and be accessible to the user for topic creation. **Permissions**: the group must have edit/move topics permission enabled; in «section moderators only» mode — user from the source secti…

**Request body** (`application/x-www-form-urlencoded`):
- `topic_id` (required, integer): Topic ID, not a poll
- `nfid` (required, integer): Forum section ID to move topic into
- `name` (optional, string): Topic title. If omitted — current value kept.
- `description` (optional, string): Brief topic description under title. If omitted — current value kept.

### `POST` `/forum/topic/close` — Close topic

**Permissions**: the group must have permission to close topics; with «simple» moderator mode enabled, the operation runs only for users from the section moderators list. If permission is not met, the DB record is not changed (API response may still be successful — check the topic via `GET /forum/topic` if needed).

**Request body** (`application/x-www-form-urlencoded`):
- `topic_id` (required, integer): Topic ID

### `POST` `/forum/topic/open` — Open topic

**Permissions**: same as topic close and with «simple» moderator mode — user from section moderators list. Without meeting the condition, topic row update may not occur despite the same successful API response — check `GET /forum/topic`.

**Request body** (`application/x-www-form-urlencoded`):
- `topic_id` (required, integer): Topic ID

### `POST` `/forum/topic/ontop` — Pin topic

**Permissions**: pin topics permission for the group; with «simple» moderator mode — user from section moderators list. Same as topic close: without actual permission, row update may not occur while response stays successful — check `GET /forum/topic`.

**Request body** (`application/x-www-form-urlencoded`):
- `topic_id` (required, integer): Topic ID

### `POST` `/forum/topic/untop` — Unpin topic

Unpins the topic in the forum section — the topic no longer appears at the top of the list. **Permissions**: «pin topics» permission for the group; in «section moderators only» moderation mode — user from section moderators list. Without permission, request may succeed but topic state won't change — verify via `GET /forum/topic`.

**Request body** (`application/x-www-form-urlencoded`):
- `topic_id` (required, integer): Topic ID

### `POST` `/forum/topic/join` — Merge topics

Joins source topic `tid` to target topic `target_id`: all posts move to the target topic, source topic is deleted, section counters are recalculated. **Limits**: - `tid` and `target_id` must not match; - target topic must exist and be in a forum section accessible to the user; - post order in target topic is preserved by send time. **Permissions**: «merge topics» permission for the group; in «section moderators only» mode — user from section moderators list.

**Request body** (`application/x-www-form-urlencoded`):
- `tid` (required, integer): Source topic ID (deleted after posts are moved)
- `target_id` (required, integer): Target topic ID to move posts into

### `POST` `/forum/topic/split` — Split topic

Creates a new topic from selected posts of an existing topic: posts listed in `post_id` move to a new topic with title `name` and description `description` in section `newforum_id`. The earliest (by send time) moved post becomes the starter post of the new topic; source and destination section counters are recalculated. **Limits**: - all posts from `post_id` must belong to one topic; - `name` — required, no longer than 63 characters; - `description` — optional, no longer than 63 characters; - `newforum_id` must exist and be accessible to the user. **Permissions**: «split topics» permission for the group; in «section moderators only» mode — user from section moderators list. Source topic ID and its section are derived from `post_id` — no need to pass them.

**Request body** (`application/x-www-form-urlencoded`):
- `post_id` (required, string): Comma-separated post IDs. All posts must belong to one topic.
- `name` (required, string): New topic title
- `description` (optional, string): New topic description (optional)
- `newforum_id` (required, integer): Forum section ID where the new topic will be created

### `POST` `/forum/topic/subscribe` — Subscribe to topic

Subscribes the current user to notifications about new posts in the topic. Repeated call on an already subscribed topic does not create duplicates — subscription state is idempotent. **Permissions**: any authorized user except the guest group.

**Request body** (`application/x-www-form-urlencoded`):
- `topic_id` (required, integer): Topic ID

### `POST` `/forum/topic/unsubscribe` — Unsubscribe from topic

Cancels the current user's subscription to notifications about new posts in the topic. Repeated call on an already unsubscribed topic is safe — state is idempotent. Method is available for forum topics only; polls have no separate `unsubscribe` operation.

**Request body** (`application/x-www-form-urlencoded`):
- `topic_id` (required, integer): Topic ID

### `GET` `/forum/posts` — Get topic posts or one post

Requires `thread_id`/`tid` and/or post `id`.

**Parameters:**
- `thread_id` (query, optional, integer): Topic / thread ID (also `tid`)
- `id` (query, optional, integer): Post ID
- `page` (query, optional, integer): Request page. Applies to list requests (topics, posts, polls — including filtering by forum); ignored when requesting a specific object by its ID
- `per_page` (query, optional, integer): Objects per request (list page size). Applies to list requests; ignored when requesting a specific object by its ID
- `user_details` (query, optional, integer): Non-zero value — extended user data

### `POST` `/forum/posts` — Add post

Adds a reply to an existing forum topic. To publish on behalf of another user, use the `user_id` parameter (the token owner's group needs the right to edit all comments). The `author` / `author_id` parameters are not supported here — they work only for topic creation (`POST /forum/topic`). For migration/import scenarios, pass `add_date` to preserve the original reply creation time. Accepted format is `YYYY-MM-DD HH:MM` or `YYYY-MM-DD` in the site's local time. Date and time parts are validated; dates later than current server time plus 24 hours and invalid values return `INVALID_DATETIME`. Backdated replies keep their own `ptime`; the topic `lpost` remains the latest post time. To attach files or images to the post, send the request as `multipart/form-data` and pass files in `file1`, `fil…

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `tid` (optional, integer): Topic ID synonym
- `id` (optional, integer): ID of the existing topic to reply in (or `tid`). Required — `MISSING_REQ_PARAM` otherwise
- `forum_id` (optional, integer): Forum ID. In uAPI it is resolved from the topic automatically, no need to pass
- `fid` (optional, integer): Forum ID synonym
- `message` (required, string): Post text, required. The maximum length is set by the module setting "Maximum message length"; `MAX_LENGTH_REACHED` when exceeded
- `user_id` (optional, integer): Numeric ID of a registered site user on whose behalf the reply is published in an existing topic (instead of the API token owner). Restrictions: - the user with this ID must exist — `USER_NOT_FOUND` otherwise; - the token owner's group needs the right to edit all comments (same as `user_id` when adding comments) — `ACCESS_DENIED` otherwise; - ban and unconfirmed e-mail checks are applied to the s…
- `add_date` (optional, string): Creation date/time for reply migration. Format: `YYYY-MM-DD HH:MM` or `YYYY-MM-DD`, in the site's local time. Year must produce a positive Unix timestamp, month/day/hour/minute must form a real date and time, and the value must not be later than current server time plus 24 hours; invalid values return `INVALID_DATETIME`.
- `subscribe` (optional, integer enum[1, 0]): Subscribe to replies in the topic. Default (when omitted) — disabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `includehtml` (optional, integer enum[1, 0]): Allow HTML in the message text. Default — enabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `end2br` (optional, integer enum[1, 0]): Convert line breaks to `<br />`. Default — enabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `smiles` (optional, integer enum[1, 0]): Smileys in the message. Default — enabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `signature` (optional, integer enum[1, 0]): Signature under the message. Default — enabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `firstontop` (optional, integer enum[1, 0]): Pin the topic first post at the top (if allowed for group). Default — disabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `ontop` (optional, integer enum[1, 0]): Pin the topic at the top of the list (if allowed for group). Default — disabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `closed` (optional, integer enum[1, 0]): Close the topic after the reply (if allowed for group). Default — disabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `file1` (optional, string(binary)): Attached file or image in slot `file1`. Pass `file2`, `file3`, ... the same way up to the forum settings limit. Available only in `multipart/form-data`; uploaded attachments are returned in the response `files` array when the method returns file information.

### `PUT` `/forum/posts` — Edit post

Edits post text and settings. To replace, add, or remove attachments in the edited post, send the request as `multipart/form-data`. New files are passed in `file1`, `file2`, ...; existing attachments are removed with `del_img1=1`, `del_img2=1`, ... .

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `id` (optional, integer): ID of the post being edited (or `p` / `post_id`). Required — `MISSING_REQ_PARAM` otherwise
- `p` (optional, integer): Post ID synonym
- `post_id` (optional, integer): Post ID synonym
- `message` (optional, string): New post text. The maximum length is set by the module setting "Maximum message length"; `MAX_LENGTH_REACHED` when exceeded
- `author_id` (optional, integer): Numeric user ID — reassign topic author when editing its first post. Available to forum moderators only.
- `file1` (optional, string(binary)): Attached file or image in slot `file1`. Pass `file2`, `file3`, ... the same way up to the forum settings limit. Available only in `multipart/form-data`; uploaded attachments are returned in the response `files` array when the method returns file information.
- `del_img1` (optional, integer enum[0, 1]): 1 — remove the attachment in slot 1. Same for `del_img2`, `del_img3`, ...

### `DELETE` `/forum/posts` — Delete post

Also accepts `p` as a synonym for `post_id`. Forum and topic fields are not needed — they are determined from the post automatically. Non-existent post — `NOT_FOUND`.

**Parameters:**
- `post_id` (query, required, integer): Post ID

### `POST` `/forum/posts/move` — Move posts

Moves posts listed in `post_id` to an existing target topic `newthread_id`. Publication time of moved posts is adjusted so they appear at the end of the target topic preserving original order; source and destination section counters are recalculated. No new topic is created — use `POST /forum/topic/split` for that. **Limits**: - all posts from `post_id` must belong to one source topic; - `newthread_id` must exist and be in a section accessible to the user; - target topic cannot match source topic; - destination section must allow the user's group to add posts; - **starter (first) topic post cannot be moved** — otherwise source topic remains empty and stops opening. For such cases use `POST /forum/topic/split` (create new topic from selected posts) or `POST /forum/topic/join` (fully merge…

**Request body** (`application/x-www-form-urlencoded`):
- `post_id` (required, string): Comma-separated post IDs to move. All posts must belong to one source topic.
- `newthread_id` (required, integer): Target topic ID to move posts into

### `POST` `/forum/posts/ontop` — Pin topic first post

Pins the starter (first) topic post so it appears at the top of **each** topic page, not just the first. Useful for section rules, announcements, important discussion context. To unpin, use `POST /forum/posts/down`. **Permissions**: «pin first post» permission for the group; in «section moderators only» mode — user from section moderators list. Without permission, request may succeed but topic state won't change — verify via `GET /forum/topic`.

**Request body** (`application/x-www-form-urlencoded`):
- `topic_id` (required, integer): Topic ID whose starter post is pinned or unpinned

### `POST` `/forum/posts/down` — Unpin topic first post

Cancels pinning of the topic starter post — it appears only on the first topic page again, in chronological order. To enable pinning, use `POST /forum/posts/ontop`. **Permissions**: «pin first post» permission for the group; in «section moderators only» mode — user from section moderators list. Without permission, request may succeed but topic state won't change — verify via `GET /forum/topic`.

**Request body** (`application/x-www-form-urlencoded`):
- `topic_id` (required, integer): Topic ID whose starter post is pinned or unpinned

### `GET` `/forum/poll` — Get list of polls or one poll

**Parameters:**
- `forum_id` (query, optional, integer): Forum ID (also accepts `fid`)
- `id` (query, optional, integer): Poll ID (synonym for `poll_id`). Note: in the response body, field `id` returns a different value — see schema description.
- `poll_id` (query, optional, integer): Synonym for parameter `id`
- `page` (query, optional, integer): Request page. Applies to list requests (topics, posts, polls — including filtering by forum); ignored when requesting a specific object by its ID
- `per_page` (query, optional, integer): Objects per request (list page size). Applies to list requests; ignored when requesting a specific object by its ID
- `password` (query, optional, string): Private forum password

### `POST` `/forum/poll` — Create poll

**Forum ID is required** — one of fields `id`, `fid` or `forum_id`. Title (`name`), first post text (`message`), question (`question`) and options (`answers`) are also required. For uAPI poll options are passed as **a single `answers` string**, values separated by **`|` character** (not newline). Poll duration `polltime` — string like `1 day`, `2 week`, `12 month`, `1 year` (number 1–12 and unit separated by space). Private forum: forum password — field `password` (as in GET) or in body.

**Request body** (`application/x-www-form-urlencoded`):
- `id` (optional, integer): Forum section ID (mutually exclusive with `fid` / `forum_id` — see `oneOf` below)
- `fid` (optional, integer): Forum ID synonym
- `forum_id` (optional, integer): Forum ID synonym
- `name` (required, string): Poll topic title
- `description` (optional, string): Topic description (up to 70 characters)
- `message` (required, string): First post text (topic body), required
- `question` (required, string): Poll question text (up to 99 characters on server)
- `answers` (required, string): Answer options for uAPI — **via `|`** (pipe), e.g. `Yes|No|Don't know`. 2 to 10 non-empty options after parsing; each option up to 110 characters; duplicates are dropped.
- `pollonly` (optional, integer enum[1, 0]): Poll-only mode — hides the topic first post. Default — disabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `pollmulty` (optional, integer enum[1, 0]): Allow multiple answer options (multi-select). Default — disabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `polltime` (optional, string): Poll duration for uAPI: pattern `\d{1,2}` + space + `day` | `week` | `month` | `year` (case insensitive). Example `1 week`. Without field — duration is unlimited.
- `includehtml` (optional, integer enum[1, 0]): Allow HTML in post text. Default (when omitted) — enabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `end2br` (optional, integer enum[1, 0]): Line breaks as `<br />`. Default — enabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `smiles` (optional, integer enum[1, 0]): Smilies in post. Default — enabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `signature` (optional, integer enum[1, 0]): Signature under post. Default — enabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `firstontop` (optional, integer enum[1, 0]): First post pinned at top of topic (if allowed for group). Default — disabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `ontop` (optional, integer enum[1, 0]): Topic pinned in list (if allowed). Default — disabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `closed` (optional, integer enum[1, 0]): Topic closed (if allowed). Default — disabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `author` (optional, string): Topic author override with moderator permissions; `-1` — wiki-bot mode (if enabled and allowed for group). Default — current OAuth user. Deprecated: use `author_id`.
- `author_id` (optional, integer): Numeric user ID — create poll on their behalf. Takes priority over `author` when both are passed. Available to forum moderators only.
- `subscribe` (optional, integer enum[1, 0]): Subscribe to topic notifications after creation. Default — disabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `user` (optional, string): Guest name (if no user session; ignored for registered users)
- `password` (optional, string): Private forum password (if required)

### `PUT` `/forum/poll` — Edit poll

**Purpose:** update question, answer options (and vote counts if needed), «poll only» / multi-select flags and poll duration. **Poll identification:** body must include one of fields `id` or `poll_id` — poll ID from the list (`GET /forum/poll`). Note: field `id` in GET response returns a different value — use `poll_id`.

**Request body** (`application/x-www-form-urlencoded`):
- `id` (optional, integer): Poll ID (same as `poll_id` in `GET /forum/poll`)
- `poll_id` (optional, integer): Synonym `id` — poll topic ID
- `question` (optional, string): Question text; omit key — keep previous from DB
- `answer1` (optional, string): Option 1: `text` or `text|votes`
- `answer2` (optional, string)
- `answer3` (optional, string)
- `answer4` (optional, string)
- `answer5` (optional, string)
- `answer6` (optional, string)
- `answer7` (optional, string)
- `answer8` (optional, string)
- `answer9` (optional, string)
- `answer10` (optional, string)
- `pollonly` (optional, integer enum[1, 0]): Poll-only mode — hides the topic first post. Default — disabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `pollmulty` (optional, integer enum[1, 0]): Allow multiple options (multi-select). Default — disabled. Legacy `yes`/`no` values are also supported — prefer `1`/`0`
- `polltime` (optional, string): New duration — `\d{1,2}` + space + `day` | `week` | `month` | `year` (case insensitive)

### `DELETE` `/forum/poll` — Delete poll (poll topic)

**Entire topic** is deleted together with all posts. There is no separate «remove poll only» operation. Also accepts `tid`, `id` or `topic_id` instead of `poll_id`.

**Parameters:**
- `poll_id` (query, required, integer): Poll ID

### `POST` `/forum/poll/move` — Move poll

Moves poll topic to another forum section `nfid`; when `name` / `description` are specified, title and description are updated at the same time. Voting data (options, vote counts, expiration) is preserved on move. Source and destination section counters are recalculated. If `nfid` is not passed and only `name` and/or `description` are set, operation reduces to renaming the poll without changing section. Behavior and limits fully match `POST /forum/topic/move` (field lengths, destination section permission check, author notification). **Permissions**: group must have edit/move topics permission; in «section moderators only» mode — user from source section moderators list. Otherwise — `ACCESS_DENIED`. Get current poll state after move with separate `GET /forum/poll?poll_id=...` request.

**Request body** (`application/x-www-form-urlencoded`):
- `poll_id` (required, integer): Poll topic ID
- `nfid` (required, integer): Destination forum section ID
- `name` (optional, string): Poll topic title; if omitted — current value kept
- `description` (optional, string): Poll topic description; if omitted — current value kept

### `POST` `/forum/poll/close` — Close poll

Closes poll topic: new posts and voting are no longer accepted. Behavior and rules fully match `POST /forum/topic/close` — poll topic is stored in DB as a regular topic with `poll=1` flag. **Permissions**: «close topics» permission for the group; in «section moderators only» mode — user from section moderators list. Without permission, request may succeed but poll state won't change — verify via `GET /forum/poll`.

**Request body** (`application/x-www-form-urlencoded`):
- `poll_id` (required, integer): Poll topic ID

### `POST` `/forum/poll/open` — Open poll

Opens a previously closed poll topic: acceptance of new posts and votes resumes. Behavior and rules fully match `POST /forum/topic/open`. **Permissions**: same as close; with «simple» moderator mode — user from section moderators list. Without permission, row update may not occur while response stays successful — check via `GET /forum/poll`.

**Request body** (`application/x-www-form-urlencoded`):
- `poll_id` (required, integer): Poll topic ID

### `POST` `/forum/poll/ontop` — Pin poll

Pins poll topic in forum section: it appears at the top of the topic list. Behavior and rules fully match `POST /forum/topic/ontop`. **Permissions**: «pin topics» permission for the group; with «simple» moderator mode — user from section moderators list. Without permission, update may not occur while response stays successful — check via `GET /forum/poll`.

**Request body** (`application/x-www-form-urlencoded`):
- `poll_id` (required, integer): Poll topic ID

### `POST` `/forum/poll/untop` — Unpin poll

Unpins poll topic — it no longer appears at the top of the topic list. Behavior and rules fully match `POST /forum/topic/untop`. **Permissions**: «pin topics» permission for the group; with «simple» moderator mode — user from section moderators list. Without permission, request may succeed but poll state won't change — check via `GET /forum/poll`.

**Request body** (`application/x-www-form-urlencoded`):
- `poll_id` (required, integer): Poll topic ID

### `POST` `/forum/poll/join` — Merge polls

Joins poll topic `poll_id` to target topic `target_id`: all posts move to target topic, poll topic is deleted, section counters are recalculated. On merge, poll data (options and vote results) from source topic **is not transferred** to target — it becomes a regular set of posts inside the target topic. **Limits**: - `poll_id` and `target_id` must not match; - target topic must exist and be in a section accessible to the user; - post order in target topic is preserved by send time. **Permissions**: «merge topics» permission for the group; in «section moderators only» mode — user from section moderators list.

**Request body** (`application/x-www-form-urlencoded`):
- `poll_id` (required, integer): Poll topic ID — source (deleted after posts are moved)
- `target_id` (required, integer): Target topic ID to move posts into

### `POST` `/forum/poll/split` — Split poll

Creates a new **regular topic** from selected poll topic posts: posts from `post_id` move to new topic `name` / `description` in section `newforum_id`. The earliest (by send time) moved post becomes the starter post of the new topic. New topic is created as regular, **without poll flag** — voting data is not copied. Source poll topic remains a poll if it still has starter post with `polldetails`. **Limits**: - all posts from `post_id` must belong to one topic; - `name` — required, no longer than 63 characters; - `description` — optional, no longer than 63 characters; - `newforum_id` must exist and be accessible to the user; - poll topic starter post (with `polldetails`) cannot be moved — that would lose the poll. **Permissions**: «split topics» permission for the group; in «section modera…

**Request body** (`application/x-www-form-urlencoded`):
- `post_id` (required, string): Comma-separated post IDs. All posts must belong to one poll topic; poll starter post cannot be moved.
- `name` (required, string): New topic title
- `description` (optional, string): New topic description (optional)
- `newforum_id` (required, integer): Forum section ID where the new topic will be created

### `POST` `/forum/poll/subscribe` — Subscribe to poll

Subscribes the current user to notifications about new posts in the poll topic. Repeated call on an already subscribed topic does not create duplicates — subscription state is idempotent. Polls have no separate `unsubscribe` method; to unsubscribe, use `POST /forum/topic/unsubscribe` with the same `topic_id` equal to `poll_id`. **Permissions**: any authorized user except the guest group.

**Request body** (`application/x-www-form-urlencoded`):
- `poll_id` (required, integer): Poll topic ID

### `GET` `/forum/poll/results` — Poll results

Returns current vote statistics by poll option: question, list of non-empty options with vote count for each, total votes and expiration flag (if set). Parameter `poll_id` accepts both poll topic ID (as in `GET /forum/poll`) and poll starter post ID; server resolves the needed record. In response `poll_id` is always the starter post ID. **Access**: public, no authorization; request respects current user permissions on the section.

**Parameters:**
- `poll_id` (query, required, integer): Poll ID from list (`poll_id` in `GET /forum/poll`) or poll ID from results (`poll_id` in `GET /forum/poll/results`)

### `POST` `/forum/poll/vote` — Vote in poll

Records the current user's vote for one or more poll options. **Multiple options** (`answer=1,3,5`) are allowed only if the poll is configured for multi-select; otherwise server returns an error. For single-choice polls pass one value only. **Limits**: - cannot vote again from the same account or IP — next call returns «already voted» error; - cannot vote after poll expiration (if set) — request returns «expired» error; - option indexes — 1 to 10 and must match non-empty poll options. **Permissions**: «vote in polls» permission for the group; without it request returns `ACCESS_DENIED`. Voting is forbidden on «abandoned» sites. After successful vote, response matches `poll_results` — recommended for displaying updated statistics without an extra request.

**Request body** (`application/x-www-form-urlencoded`):
- `poll_id` (required, integer): Poll ID from list (`poll_id` in `GET /forum/poll`) or from results (`poll_id` in `GET /forum/poll/results`)
- `answer` (required, string): Selected option index (**1–10**). For multi-select polls multiple indexes can be passed comma-separated; for regular polls — one value only.

---
## Directory Module

OpenAPI: https://api.ucoz.net/dir-openapi.yaml

| Method | Path | Summary |
|---|---|---|
| `GET` | `/dir` | Get all module entries |
| `POST` | `/dir` | Add entry |
| `PUT` | `/dir` | Edit entry |
| `DELETE` | `/dir/posts` | Delete entry |
| `POST` | `/dir/tags` | Add/update entry tags |
| `GET` | `/dir/category` | Get category list |
| `POST` | `/dir/category` | Add category |
| `PUT` | `/dir/category` | Edit category |
| `DELETE` | `/dir/category` | Delete category |
| `GET` | `/dir/comments` | Get entry comments |
| `POST` | `/dir/comments` | Add comment |
| `PUT` | `/dir/comments` | Edit comment |
| `DELETE` | `/dir/comments` | Delete comment |
| `GET` | `/dir/filter` | Get filter list |
| `POST` | `/dir/filter` | Add filter |
| `PUT` | `/dir/filter` | Update filter |
| `DELETE` | `/dir/filter` | Delete filter |
| `GET` | `/dir/fields` | Get module field settings |

### `GET` `/dir` — Get all module entries

Get a list of all entries in the "Site directory" module. The number of entries per page depends on module settings.

**Parameters:**
- `page` (query, optional, integer): Page number.
- `per_page` (query, optional, integer): Number of entries per page.
- `date` (query, optional, string): Filter by date in yyyy-mm-dd or yyyy format
- `id` (query, optional, integer): ID of a specific entry
- `category` (query, optional, integer): Filter by category ID (non-existing category — `NOT_FOUND`)
- `user_id` (query, optional, integer): Filter by numeric ID of the entry author
- `pending` (query, optional, integer): Non-zero value — return only entries pending activation (premoderation)

### `POST` `/dir` — Add entry

Add a new entry to the "Site directory" module Text fields can be sent in `application/x-www-form-urlencoded`. File fields (`screenshot`, `archive`, `cover`, `file1`…`fileN`) are sent only in `multipart/form-data` (text fields may go in the same request).

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `category` (required, integer | string): Category ID or a comma-separated list of IDs (`3` or `3,4`). A list works only when the module option "Allow an entry to belong to multiple categories" is enabled (`options_other_categories` / `other_categories` in `/setup`). The primary category is determined by the category order in the control panel, not by the order of IDs in the submitted list. Parameters `ocat`, `ocats`, `categories`, and `…
- `title` (required, string): Entry title
- `description` (optional, string): Short entry description
- `message` (optional, string): Full entry description
- `description_type` (optional, string enum['plain', 'bb', 'html']): Short description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `message_type` (optional, string enum['plain', 'bb', 'html']): Full description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `comments` (optional, integer enum[1, 0]): Allow comments on the entry Default — enabled. Legacy `yes`/`no` values are also supported
- `ontop` (optional, integer enum[1, 0]): Always show the entry at the top Default — disabled. Legacy `yes`/`no` values are also supported
- `pending` (optional, integer enum[1, 0]): Put the entry into pending activation (premoderation) Default — disabled. Legacy `yes`/`no` values are also supported
- `includehtml_desc` (optional, integer enum[1, 0]): Allow HTML in the short description Default — enabled. Legacy `yes`/`no` values are also supported
- `includehtml_msg` (optional, integer enum[1, 0]): Allow HTML in the full description Default — enabled. Legacy `yes`/`no` values are also supported
- `end2br_desc` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the short description Default — disabled. Legacy `yes`/`no` values are also supported
- `end2br_msg` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the full description Default — disabled. Legacy `yes`/`no` values are also supported
- `subscribe` (optional, integer enum[1, 0]): Subscribe to entry comments Default — disabled. Legacy `yes`/`no` values are also supported
- `uto` (optional, integer enum[1, 0]): Replace external links using the u.to service Default — disabled. Legacy `yes`/`no` values are also supported
- `name` (optional, string): Site owner name
- `author_email` (optional, string): Author e-mail
- `author_site` (optional, string): Author website
- `link2site` (optional, string): Link to the site (the main "Site catalog" module field)
- `screenshot` (optional, string(binary)): Entry screenshot — `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp` image. Sent only in `multipart/form-data`. Maximum size — module setting (KB)
- `archive` (optional, string(binary)): Archive file (arbitrary downloadable file). Sent only in `multipart/form-data`. Maximum size is limited by site settings/plan
- `cover` (optional, string(binary)): Entry cover — `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp` image. Sent only in `multipart/form-data`. Maximum size — the cover setting (KB)
- `file1` (optional, string(binary)): Embedded image in entry text — slots `file1`, `file2`, … up to the module settings limit. Extensions: `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp`; maximum size — module setting (KB). Sent only in `multipart/form-data`. Uploaded images are returned in the `files` array of responses.
- `add_date` (optional, string): Publication date and time as `yyyy-mm-dd hh:mm`. Works if the "add date" option is enabled in the control panel
- `ownurl` (optional, string): Entry custom URL (SEO-friendly)
- `other1` (optional, string): Additional field 1 (max length — site plan limit)
- `other2` (optional, string): Additional field 2 (max length — site plan limit)
- `other3` (optional, string): Additional field 3 (max length — site plan limit)
- `other4` (optional, string): Additional field 4 (max length — site plan limit)
- `other5` (optional, string): Additional field 5 (max length — site plan limit)
- `author` (optional, string): Existing user nickname. Deprecated — use `author_id`. Available to module administrators and editors only.
- `author_id` (optional, integer): User ID — publish entry on their behalf. Takes priority over `author`. Available to module administrators and editors only.
- `tags` (optional, string): Entry tags, comma-separated (tag1,tag2,tag3)

### `PUT` `/dir` — Edit entry

Edit an existing entry PATCH semantics apply: omitted fields keep their current values. File fields (`screenshot`, `archive`, `cover`, `file1`…`fileN`) are sent only in `multipart/form-data`.

**Parameters:**
- `id` (query, required, integer): Entry ID

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `category` (optional, integer | string): Category ID or a comma-separated list of IDs (`3` or `3,4`). When sent, fully replaces the entry's current category set (e.g. entry was in 3 and 4; after `category=4` it remains only in 4). A list works only when the module option "Allow an entry to belong to multiple categories" is enabled. The primary category is determined by the category order in the control panel, not by the order of IDs in…
- `title` (optional, string): Entry title
- `description` (optional, string): Short entry description
- `message` (optional, string): Full entry description
- `description_type` (optional, string enum['plain', 'bb', 'html']): Short description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `message_type` (optional, string enum['plain', 'bb', 'html']): Full description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `comments` (optional, integer enum[1, 0]): Allow comments on the entry Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `ontop` (optional, integer enum[1, 0]): Always show the entry at the top Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `pending` (optional, integer enum[1, 0]): Put the entry into pending activation (premoderation) Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `includehtml_desc` (optional, integer enum[1, 0]): Allow HTML in the short description Default — enabled. Legacy `yes`/`no` values are also supported
- `includehtml_msg` (optional, integer enum[1, 0]): Allow HTML in the full description Default — enabled. Legacy `yes`/`no` values are also supported
- `end2br_desc` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the short description Default — disabled. Legacy `yes`/`no` values are also supported
- `end2br_msg` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the full description Default — disabled. Legacy `yes`/`no` values are also supported
- `subscribe` (optional, integer enum[1, 0]): Subscribe to entry comments Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `uto` (optional, integer enum[1, 0]): Replace external links using the u.to service Default — disabled. Legacy `yes`/`no` values are also supported
- `name` (optional, string): Site owner name
- `author_email` (optional, string): Author e-mail
- `author_site` (optional, string): Author website
- `link2site` (optional, string): Link to the site (the main "Site catalog" module field)
- `hgu_title` (optional, string): Entry SEO-friendly URL. Omitted — the current value is kept
- `screenshot` (optional, string(binary)): Entry screenshot — `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp` image. Sent only in `multipart/form-data`. Maximum size — module setting (KB)
- `archive` (optional, string(binary)): Archive file (arbitrary downloadable file). Sent only in `multipart/form-data`. Maximum size is limited by site settings/plan
- `cover` (optional, string(binary)): Entry cover — `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp` image. Sent only in `multipart/form-data`. Maximum size — the cover setting (KB)
- `cover_delete` (optional, integer enum[0, 1]): 1 — remove the current cover when editing (if one was uploaded); 0 — keep it
- `file1` (optional, string(binary)): Embedded image — slots `file1`, `file2`, …; `multipart/form-data` only. PATCH semantics: a slot without an uploaded file keeps its current image. Remove a slot with `del_imgN=1`.
- `del_img1` (optional, integer enum[0, 1]): 1 — remove embedded image in slot 1. Same for `del_img2`, `del_img3`, …
- `add_date` (optional, string): Publication date and time as `yyyy-mm-dd hh:mm`. Works if the "add date" option is enabled in the control panel
- `uplastmod` (optional, integer enum[0, 1]): 1 — write the current server time into the entry modification date. 0 or omitted — leave the modification date unchanged even if the entry was edited. An arbitrary date cannot be set with this field. The parameter only works for users with full edit rights for the module; for everyone else it is silently ignored. The result appears in the `mod_date` / `mod_date_ts` fields of the module list respo…
- `ownurl` (optional, string): Entry custom URL (SEO-friendly)
- `other1` (optional, string): Additional field 1 (max length — site plan limit)
- `other2` (optional, string): Additional field 2 (max length — site plan limit)
- `other3` (optional, string): Additional field 3 (max length — site plan limit)
- `other4` (optional, string): Additional field 4 (max length — site plan limit)
- `other5` (optional, string): Additional field 5 (max length — site plan limit)
- `author` (optional, string): Existing user nickname. Deprecated — use `author_id`. Available to module administrators and editors only.
- `author_id` (optional, integer): User ID — publish entry on their behalf. Takes priority over `author`. Available to module administrators and editors only.

### `DELETE` `/dir/posts` — Delete entry

Delete an entry from the module

**Parameters:**
- `id` (query, required, integer): Entry ID

### `POST` `/dir/tags` — Add/update entry tags

Add, change, or remove tags for an entry. - To remove all tags, send an empty request - To edit tags, send the full list of tags that should remain - To add new tags, send existing tags plus new ones Tags are comma-separated.

**Request body** (`application/x-www-form-urlencoded`):
- `id` (required, integer): Entry ID
- `tags` (optional, string): Comma-separated list of tags

### `GET` `/dir/category` — Get category list

Get all categories in the "Site directory" module

**Parameters:**
- `id` (query, optional, integer): ID of a specific category

### `POST` `/dir/category` — Add category

Add a new category

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `name` (required, string): Category name
- `description` (optional, string): Category description
- `hgu_title` (optional, string): Category SEO-friendly URL
- `ownurl` (optional, string): Custom category slug (without domain)
- `position` (optional, integer): Category position in the list
- `access2category` (optional, string): Comma-separated group IDs allowed to view the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2add` (optional, string): Comma-separated group IDs allowed to add entries to the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2page` (optional, string): Comma-separated group IDs allowed to view the category page. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `file` (optional, string(binary)): Category image

### `PUT` `/dir/category` — Edit category

Edit an existing category

**Parameters:**
- `id` (query, required, integer): Category ID

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `name` (optional, string)
- `description` (optional, string)
- `hgu_title` (optional, string)
- `ownurl` (optional, string): Custom category slug (without domain)
- `position` (optional, integer)
- `access2category` (optional, string): Comma-separated group IDs allowed to view the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2add` (optional, string): Comma-separated group IDs allowed to add entries to the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2page` (optional, string): Comma-separated group IDs allowed to view the category page. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `file` (optional, string(binary)): Category image

### `DELETE` `/dir/category` — Delete category

**Parameters:**
- `id` (query, required, integer): Category ID

### `GET` `/dir/comments` — Get entry comments

Get all comments for a specific entry

**Parameters:**
- `id` (query, required, integer): Entry ID

### `POST` `/dir/comments` — Add comment

Add a comment to an entry

**Request body** (`application/x-www-form-urlencoded`):
- `entry_id` (required, integer): Entry ID
- `message` (required, string): Comment text
- `pros` (optional, string): Entry pros
- `cons` (optional, string): Entry cons
- `parent_id` (optional, integer): Parent comment ID (for replies)
- `user_id` (optional, integer): User ID on whose behalf the comment is added. Works only when called by a user with permission to edit all comments.
- `subscribe_to_replies` (optional, string): Subscribe the authenticated user to replies for the entry after adding the comment. Value 0/no does not create a subscription; 1/yes creates a subscription. By default, the subscription is created.

### `PUT` `/dir/comments` — Edit comment

Edit an existing comment

**Parameters:**
- `id` (query, required, integer): Comment ID

**Request body** (`application/x-www-form-urlencoded`):
- `message` (optional, string): Comment text
- `pros` (optional, string): Entry pros
- `cons` (optional, string): Entry cons

### `DELETE` `/dir/comments` — Delete comment

**Parameters:**
- `id` (query, required, integer): Comment ID

### `GET` `/dir/filter` — Get filter list

Get all module filters

**Parameters:**
- `filter_id` (query, optional, integer): Filter ID

### `POST` `/dir/filter` — Add filter

Add a new filter

**Request body** (`application/x-www-form-urlencoded`):
- `filter_num` (required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)
- `name` (required, string): Filter name
- `items` (required, string): Values separated by |
- `multiselect` (optional, string enum[True, False]): Multiple selection (yes/no)
- `multi4userdisabled` (optional, string enum[True, False]): Multiple selection for regular users

### `PUT` `/dir/filter` — Update filter

Update an existing filter

**Request body** (`application/x-www-form-urlencoded`):
- `filter_num` (required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)
- `name` (optional, string): New filter name
- `items` (optional, string): New values separated by |
- `multiselect` (optional, string enum[True, False])
- `multi4userdisabled` (optional, string enum[True, False])

### `DELETE` `/dir/filter` — Delete filter

Delete a module filter

**Parameters:**
- `filter_num` (query, required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)

### `GET` `/dir/fields` — Get module field settings

Shows available module fields

---
## File Catalog Module

OpenAPI: https://api.ucoz.net/load-openapi.yaml

| Method | Path | Summary |
|---|---|---|
| `GET` | `/load` | Get all module entries |
| `POST` | `/load` | Add entry |
| `PUT` | `/load` | Update entry |
| `DELETE` | `/load/posts` | Delete entry |
| `POST` | `/load/tags` | Add or update entry tags |
| `GET` | `/load/category` | Get category list |
| `POST` | `/load/category` | Add category |
| `PUT` | `/load/category` | Update category |
| `DELETE` | `/load/category` | Delete category |
| `GET` | `/load/comments` | Get entry comments |
| `POST` | `/load/comments` | Add comment |
| `PUT` | `/load/comments` | Update comment |
| `DELETE` | `/load/comments` | Delete comment |
| `GET` | `/load/filter` | Get filter list |
| `POST` | `/load/filter` | Add filter |
| `PUT` | `/load/filter` | Update filter |
| `DELETE` | `/load/filter` | Delete filter |
| `GET` | `/load/fields` | Get module field settings |

### `GET` `/load` — Get all module entries

Get a list of all entries in the "File catalog" module. The number of entries per page depends on module settings.

**Parameters:**
- `page` (query, optional, integer): Page number.
- `per_page` (query, optional, integer): Number of entries per page.
- `date` (query, optional, string): Filter by date in yyyy-mm-dd or yyyy format
- `id` (query, optional, integer): ID of a specific entry

### `POST` `/load` — Add entry

Add a new entry to the "File catalog" module

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `category` (required, integer | string): Category ID or a comma-separated list of IDs (`3` or `3,4`). A list works only when the module option "Allow an entry to belong to multiple categories" is enabled (`options_other_categories` / `other_categories` in `/setup`). The primary category is determined by the category order in the control panel, not by the order of IDs in the submitted list. Parameters `ocat`, `ocats`, `categories`, and `…
- `title` (required, string): Entry title
- `description` (optional, string): Short entry description
- `message` (optional, string): Full entry description
- `version` (optional, string): Entry version
- `language` (optional, integer): Interface language ID
- `archlink` (optional, string): Archive download link on another server
- `archlink_size` (optional, string): Archive size on another server
- `author` (optional, string): Nickname of an existing user. Deprecated — use `author_id`. Available only to module administrators and editors. Do not confuse with `name` — the display name of the file author.
- `author_id` (optional, integer): User ID — publish the entry on behalf of this user. Takes precedence over `author`. Available only to module administrators and editors.
- `author_email` (optional, string): Author email
- `author_site` (optional, string): Author website
- `link2prog` (optional, string): Link to entry source
- `link2doc` (optional, string): Link to entry documentation page
- `subscribe` (optional, string enum[True, False]): Subscribe to entry
- `who_add` (optional, string): Nickname of who adds the entry
- `os` (optional, integer): Operating systems
- `archive` (optional, string(binary)): Archive file — the main downloadable file of the entry. Sent only in `multipart/form-data`. Maximum size is limited by the site plan. Works when the "Archive file" field is enabled. In the response: `archive_url` (link with a download counter), `archive_direct_url` (direct path), `archive_size`.
- `screenshot` (optional, string(binary)): Entry screenshot — `jpg`/`jpeg`/`jpe`/`png`/`gif`/`webp` image. Sent only in `multipart/form-data`. Works when the "Screenshot" field is enabled. In the response: `screenshot_direct_url` and `screenshot_size`.
- `cover` (optional, string(binary)): Entry cover — `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp` image. Sent only in `multipart/form-data`. Maximum size — the cover setting (KB)
- `file1` (optional, string(binary)): Embedded image in entry text — slots `file1`, `file2`, … up to the module settings limit. Extensions: `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp`. Sent only in `multipart/form-data`. Works when the "Images" field is enabled. Uploaded images are returned in the `files` array of responses.
- `meta_title` (optional, string): Meta Title
- `meta_description` (optional, string): Meta Description
- `meta_keywords` (optional, string): Meta Keywords
- `ownurl` (optional, string): Custom entry URL (SEO-friendly)
- `add_date` (optional, string): Entry publication date and time as `yyyy-mm-dd hh:mm`. Works if the add-date option is enabled in module settings.
- `other1` (optional, string): Additional field 1
- `other2` (optional, string): Additional field 2
- `other3` (optional, string): Additional field 3
- `other4` (optional, string): Additional field 4
- `other5` (optional, string): Additional field 5

### `PUT` `/load` — Update entry

Update an existing entry

**Parameters:**
- `id` (query, required, integer): Entry ID

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `category` (optional, integer | string): Category ID or a comma-separated list of IDs (`3` or `3,4`). When sent, fully replaces the entry's current category set (e.g. entry was in 3 and 4; after `category=4` it remains only in 4). A list works only when the module option "Allow an entry to belong to multiple categories" is enabled. The primary category is determined by the category order in the control panel, not by the order of IDs in…
- `title` (optional, string): Entry title
- `description` (optional, string): Short entry description
- `message` (optional, string): Full entry description
- `hgu_title` (optional, string): Entry SEO-friendly URL
- `archlink` (optional, string): Archive download link on another server
- `archlink_size` (optional, string): Archive size on another server
- `archive` (optional, string(binary)): Archive file — the main downloadable file; sent only in `multipart/form-data`, replaces the current file. In the response: `archive_url`, `archive_direct_url`, `archive_size`.
- `file_delete` (optional, integer enum[0, 1]): 1 — remove the attached archive file; 0 — keep it
- `screenshot` (optional, string(binary)): Entry screenshot; sent only in `multipart/form-data`, replaces the current one.
- `dscreen` (optional, integer enum[0, 1]): 1 — remove the entry screenshot; 0 — keep it
- `cover` (optional, string(binary)): Entry cover — `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp` image. Sent only in `multipart/form-data`. Maximum size — the cover setting (KB)
- `cover_delete` (optional, integer enum[0, 1]): 1 — remove the current cover when editing (if one was uploaded); 0 — keep it
- `file1` (optional, string(binary)): Embedded image — slots `file1`, `file2`, …; `multipart/form-data` only. PATCH semantics: a slot without an uploaded file keeps its current image. Remove a slot with `del_imgN=1`.
- `del_img1` (optional, integer enum[0, 1]): 1 — remove embedded image in slot 1 (same for `del_img2`, `del_img3`, …)
- `meta_title` (optional, string): Meta Title
- `meta_description` (optional, string): Meta Description
- `meta_keywords` (optional, string): Meta Keywords
- `ownurl` (optional, string): Custom entry URL (SEO-friendly)
- `add_date` (optional, string): Entry publication date and time as `yyyy-mm-dd hh:mm`. Works if the add-date option is enabled in module settings.
- `uplastmod` (optional, integer enum[0, 1]): 1 — write the current server time into the entry modification date. 0 or omitted — leave the modification date unchanged even if the entry was edited. An arbitrary date cannot be set with this field. The parameter only works for users with full edit rights for the module; for everyone else it is silently ignored. The result appears in the `mod_date` / `mod_date_ts` fields of the module list respo…
- `other1` (optional, string)
- `other2` (optional, string)
- `other3` (optional, string)
- `other4` (optional, string)
- `other5` (optional, string)
- `author` (optional, string): Nickname of an existing user. Deprecated — use `author_id`. Available only to module administrators and editors. Do not confuse with `name` — the display name of the file author.
- `author_id` (optional, integer): User ID — republish the entry on behalf of this user. Takes precedence over `author`. Available only to module administrators and editors.

### `DELETE` `/load/posts` — Delete entry

Delete an entry from the module

**Parameters:**
- `id` (query, required, integer): Entry ID

### `POST` `/load/tags` — Add or update entry tags

Add, update, or remove tags on an entry. - To remove all tags, send an empty request - To edit tags, send the full list of tags that should remain - To add new tags, include existing tags plus new ones Tags are comma-separated.

**Request body** (`application/x-www-form-urlencoded`):
- `id` (required, integer): Entry ID
- `tags` (optional, string): Comma-separated tag list

### `GET` `/load/category` — Get category list

Get all categories in the "File catalog" module

**Parameters:**
- `id` (query, optional, integer): ID of a specific category

### `POST` `/load/category` — Add category

Add a new category

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `name` (required, string): Category name
- `description` (optional, string): Category description
- `hgu_title` (optional, string): Category SEO-friendly URL. Applied only on edit (PUT). On creation it is generated automatically from `name`.
- `ownurl` (optional, string): Custom category slug (without domain)
- `position` (optional, integer)
- `access2category` (optional, string): Comma-separated group IDs allowed to view the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2add` (optional, string): Comma-separated group IDs allowed to add entries to the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2page` (optional, string): Comma-separated group IDs allowed to view the category page. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests Category position in the list. Applied only on edit (PUT). On creation it is assigned automatically.
- `file` (optional, string(binary)): Category image

### `PUT` `/load/category` — Update category

Update an existing category

**Parameters:**
- `id` (query, required, integer): Category ID

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `name` (optional, string)
- `description` (optional, string)
- `hgu_title` (optional, string)
- `ownurl` (optional, string): Custom category slug (without domain)
- `position` (optional, integer)
- `access2category` (optional, string): Comma-separated group IDs allowed to view the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2add` (optional, string): Comma-separated group IDs allowed to add entries to the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2page` (optional, string): Comma-separated group IDs allowed to view the category page. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `file` (optional, string(binary)): Category image

### `DELETE` `/load/category` — Delete category

Delete a category

**Parameters:**
- `id` (query, required, integer): Category ID

### `GET` `/load/comments` — Get entry comments

Get all comments for a specific entry

**Parameters:**
- `id` (query, required, integer): Entry ID

### `POST` `/load/comments` — Add comment

Add a comment to an entry

**Request body** (`application/x-www-form-urlencoded`):
- `entry_id` (required, integer): Entry ID
- `message` (required, string): Comment text
- `pros` (optional, string): Entry pros
- `cons` (optional, string): Entry cons
- `parent_id` (optional, integer): Parent comment ID (for replies)
- `user_id` (optional, integer): User ID on whose behalf the comment is added. Works only when called by a user with permission to edit all comments.
- `subscribe_to_replies` (optional, string): Subscribe the authenticated user to replies for the entry after adding the comment. Value 0/no does not create a subscription; 1/yes creates a subscription. By default, the subscription is created.

### `PUT` `/load/comments` — Update comment

Update an existing comment

**Parameters:**
- `id` (query, required, integer): Comment ID

**Request body** (`application/x-www-form-urlencoded`):
- `message` (optional, string): Comment text
- `pros` (optional, string): Entry pros
- `cons` (optional, string): Entry cons

### `DELETE` `/load/comments` — Delete comment

Delete a comment

**Parameters:**
- `id` (query, required, integer): Comment ID

### `GET` `/load/filter` — Get filter list

Get all module filters

**Parameters:**
- `filter_id` (query, optional, integer): Filter ID

### `POST` `/load/filter` — Add filter

Add a new filter

**Request body** (`application/x-www-form-urlencoded`):
- `filter_num` (required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)
- `name` (required, string): Filter name
- `items` (required, string): Values separated by |
- `multiselect` (optional, string enum[True, False]): Multiple selection (yes/no)
- `multi4userdisabled` (optional, string enum[True, False]): Disable multiple selection for regular users (yes/no)

### `PUT` `/load/filter` — Update filter

Update an existing filter

**Request body** (`application/x-www-form-urlencoded`):
- `filter_num` (required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)
- `name` (optional, string): New filter name
- `items` (optional, string): New values separated by |
- `multiselect` (optional, string enum[True, False])
- `multi4userdisabled` (optional, string enum[True, False])

### `DELETE` `/load/filter` — Delete filter

Delete a module filter

**Parameters:**
- `filter_num` (query, required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)

### `GET` `/load/fields` — Get module field settings

Returns available module fields

---
## Guestbook Module

OpenAPI: https://api.ucoz.net/gb-openapi.yaml

| Method | Path | Summary |
|---|---|---|
| `GET` | `/gb` | Get all guestbook entries |
| `POST` | `/gb` | Add entry |
| `PUT` | `/gb` | Update entry |
| `DELETE` | `/gb` | Delete entry |
| `POST` | `/gb/rate` | Rate entry |
| `GET` | `/gb/fields` | Get module field settings |

### `GET` `/gb` — Get all guestbook entries

Get a list of all guestbook entries. The number of entries per page depends on module settings.

**Parameters:**
- `page` (query, optional, integer): Page number.
- `per_page` (query, optional, integer): Number of entries per page.

### `POST` `/gb` — Add entry

Add a new entry to the guestbook

**Request body** (`application/x-www-form-urlencoded`):
- `message` (required, string): Entry text
- `name` (optional, string): Author name
- `email` (optional, string): Author email
- `www` (optional, string): Author website
- `custom1` (optional, string): Additional field 1
- `custom2` (optional, string): Additional field 2

### `PUT` `/gb` — Update entry

Update an existing entry

**Parameters:**
- `id` (query, required, integer): Entry ID

**Request body** (`application/x-www-form-urlencoded`):
- `message` (optional, string): Entry text
- `name` (optional, string): Author name
- `email` (optional, string): Author email
- `www` (optional, string): Author website
- `custom1` (optional, string): Additional field 1
- `custom2` (optional, string): Additional field 2

### `DELETE` `/gb` — Delete entry

Delete an entry from the guestbook

**Parameters:**
- `id` (query, required, integer): Entry ID

### `POST` `/gb/rate` — Rate entry

Rate a guestbook entry

**Request body** (`application/x-www-form-urlencoded`):
- `id` (required, integer): Entry ID
- `mark` (required, integer): Rating (1 — good, 2 — bad)

### `GET` `/gb/fields` — Get module field settings

Returns available module fields

---
## Online Games Module

OpenAPI: https://api.ucoz.net/stuff-openapi.yaml

| Method | Path | Summary |
|---|---|---|
| `GET` | `/stuff` | Get all module entries |
| `POST` | `/stuff` | Add entry |
| `PUT` | `/stuff` | Edit entry |
| `DELETE` | `/stuff/posts` | Delete entry |
| `POST` | `/stuff/tags` | Add/update entry tags |
| `GET` | `/stuff/category` | Get category list |
| `POST` | `/stuff/category` | Add category |
| `PUT` | `/stuff/category` | Edit category |
| `DELETE` | `/stuff/category` | Delete category |
| `GET` | `/stuff/comments` | Get entry comments |
| `POST` | `/stuff/comments` | Add comment |
| `PUT` | `/stuff/comments` | Edit comment |
| `DELETE` | `/stuff/comments` | Delete comment |
| `GET` | `/stuff/filter` | Get filter list |
| `POST` | `/stuff/filter` | Add filter |
| `PUT` | `/stuff/filter` | Update filter |
| `DELETE` | `/stuff/filter` | Delete filter |
| `GET` | `/stuff/fields` | Get module field settings |

### `GET` `/stuff` — Get all module entries

Get a list of all entries in the "Online games" module. The number of entries per page depends on module settings.

**Parameters:**
- `page` (query, optional, integer): Page number.
- `per_page` (query, optional, integer): Entries per page.
- `date` (query, optional, string): Filter by date as yyyy-mm-dd or yyyy
- `id` (query, optional, integer): ID of a specific entry
- `category` (query, optional, integer): Filter by category ID (non-existing category — `NOT_FOUND`)
- `user_id` (query, optional, integer): Filter by numeric ID of the entry author
- `pending` (query, optional, integer): Non-zero value — return only entries pending activation (premoderation)

### `POST` `/stuff` — Add entry

Add a new entry to the "Online games" module Text fields can be sent in `application/x-www-form-urlencoded`. File fields (`screenshot`, `archive`, `cover`, `file1`…`fileN`) are sent only in `multipart/form-data` (text fields may go in the same request).

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `category` (required, integer | string): Category ID or a comma-separated list of IDs (`3` or `3,4`). A list works only when the module option "Allow an entry to belong to multiple categories" is enabled (`options_other_categories` / `other_categories` in `/setup`). The primary category is determined by the category order in the control panel, not by the order of IDs in the submitted list. Parameters `ocat`, `ocats`, `categories`, and `…
- `title` (required, string): Entry title
- `description` (optional, string): Short entry description
- `message` (optional, string): Full entry description
- `description_type` (optional, string enum['plain', 'bb', 'html']): Short description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `message_type` (optional, string enum['plain', 'bb', 'html']): Full description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `comments` (optional, integer enum[1, 0]): Allow comments on the entry Default — enabled. Legacy `yes`/`no` values are also supported
- `ontop` (optional, integer enum[1, 0]): Always show the entry at the top Default — disabled. Legacy `yes`/`no` values are also supported
- `pending` (optional, integer enum[1, 0]): Put the entry into pending activation (premoderation) Default — disabled. Legacy `yes`/`no` values are also supported
- `includehtml_desc` (optional, integer enum[1, 0]): Allow HTML in the short description Default — enabled. Legacy `yes`/`no` values are also supported
- `includehtml_msg` (optional, integer enum[1, 0]): Allow HTML in the full description Default — enabled. Legacy `yes`/`no` values are also supported
- `end2br_desc` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the short description Default — disabled. Legacy `yes`/`no` values are also supported
- `end2br_msg` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the full description Default — disabled. Legacy `yes`/`no` values are also supported
- `subscribe` (optional, integer enum[1, 0]): Subscribe to entry comments Default — disabled. Legacy `yes`/`no` values are also supported
- `uto` (optional, integer enum[1, 0]): Replace external links using the u.to service Default — disabled. Legacy `yes`/`no` values are also supported
- `name` (optional, string): Game author name
- `author_email` (optional, string): Author e-mail
- `author_site` (optional, string): Author website
- `link2swf` (optional, string): Link to the game SWF file
- `playground_width` (optional, integer): Playground width (px)
- `playground_height` (optional, integer): Playground height (px)
- `link2pc` (optional, string): Link to the PC game file
- `link2mac` (optional, string): Link to the Mac game file
- `link2mob` (optional, string): Link to the Mobile game file
- `sort_order` (optional, integer): Manual sort value 0–255 (for module editors)
- `filter1` (optional, string): Filter 1 values — comma-separated value IDs (see `GET /stuff/filter`). Whether it is required depends on module settings
- `filter2` (optional, string): Filter 2 values — comma-separated value IDs (see `GET /stuff/filter`). Whether it is required depends on module settings
- `filter3` (optional, string): Filter 3 values — comma-separated value IDs (see `GET /stuff/filter`). Whether it is required depends on module settings
- `screenshot` (optional, string(binary)): Game logo/screenshot — `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp` image. Sent only in `multipart/form-data`. Maximum size — module setting (KB)
- `archive` (optional, string(binary)): Archive file (arbitrary downloadable file). Sent only in `multipart/form-data`. Maximum size is limited by site settings/plan
- `cover` (optional, string(binary)): Entry cover — `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp` image. Sent only in `multipart/form-data`. Maximum size — the cover setting (KB)
- `file1` (optional, string(binary)): Embedded image in entry text — slots `file1`, `file2`, … up to the module settings limit. Extensions: `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp`; maximum size — module setting (KB). Sent only in `multipart/form-data`. Uploaded images are returned in the `files` array of responses.
- `add_date` (optional, string): Publication date and time as `yyyy-mm-dd hh:mm`. Works if the "add date" option is enabled in the control panel
- `meta_title` (optional, string): Meta Title
- `meta_description` (optional, string): Meta Description
- `meta_keywords` (optional, string): Meta Keywords
- `ownurl` (optional, string): Entry custom URL (SEO-friendly)
- `other1` (optional, string): Additional field 1 (max length — site plan limit)
- `other2` (optional, string): Additional field 2 (max length — site plan limit)
- `other3` (optional, string): Additional field 3 (max length — site plan limit)
- `other4` (optional, string): Additional field 4 (max length — site plan limit)
- `other5` (optional, string): Additional field 5 (max length — site plan limit)
- `author` (optional, string): Existing user nickname. Deprecated — use `author_id`. Available to module administrators and editors only.
- `author_id` (optional, integer): User ID — publish entry on their behalf. Takes priority over `author`. Available to module administrators and editors only.
- `tags` (optional, string): Entry tags, comma-separated (tag1,tag2,tag3)

### `PUT` `/stuff` — Edit entry

Edit existing entry PATCH semantics apply: omitted fields keep their current values. File fields (`screenshot`, `archive`, `cover`, `file1`…`fileN`) are sent only in `multipart/form-data`.

**Parameters:**
- `id` (query, required, integer): Entry ID

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `category` (optional, integer | string): Category ID or a comma-separated list of IDs (`3` or `3,4`). When sent, fully replaces the entry's current category set (e.g. entry was in 3 and 4; after `category=4` it remains only in 4). A list works only when the module option "Allow an entry to belong to multiple categories" is enabled. The primary category is determined by the category order in the control panel, not by the order of IDs in…
- `title` (optional, string): Entry title
- `description` (optional, string): Short entry description
- `message` (optional, string): Full entry description
- `description_type` (optional, string enum['plain', 'bb', 'html']): Short description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `message_type` (optional, string enum['plain', 'bb', 'html']): Full description text format: `plain` — plain text (default), `bb` — BB codes, `html` — HTML
- `comments` (optional, integer enum[1, 0]): Allow comments on the entry Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `ontop` (optional, integer enum[1, 0]): Always show the entry at the top Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `pending` (optional, integer enum[1, 0]): Put the entry into pending activation (premoderation) Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `includehtml_desc` (optional, integer enum[1, 0]): Allow HTML in the short description Default — enabled. Legacy `yes`/`no` values are also supported
- `includehtml_msg` (optional, integer enum[1, 0]): Allow HTML in the full description Default — enabled. Legacy `yes`/`no` values are also supported
- `end2br_desc` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the short description Default — disabled. Legacy `yes`/`no` values are also supported
- `end2br_msg` (optional, integer enum[1, 0]): Convert line breaks to `<br />` in the full description Default — disabled. Legacy `yes`/`no` values are also supported
- `subscribe` (optional, integer enum[1, 0]): Subscribe to entry comments Omitted — the current value is kept. Legacy `yes`/`no` values are also supported
- `uto` (optional, integer enum[1, 0]): Replace external links using the u.to service Default — disabled. Legacy `yes`/`no` values are also supported
- `name` (optional, string): Game author name
- `author_email` (optional, string): Author e-mail
- `author_site` (optional, string): Author website
- `link2swf` (optional, string): Link to the game SWF file
- `playground_width` (optional, integer): Playground width (px)
- `playground_height` (optional, integer): Playground height (px)
- `link2pc` (optional, string): Link to the PC game file
- `link2mac` (optional, string): Link to the Mac game file
- `link2mob` (optional, string): Link to the Mobile game file
- `sort_order` (optional, integer): Manual sort value 0–255 (for module editors)
- `filter1` (optional, string): Filter 1 values — comma-separated value IDs (see `GET /stuff/filter`). Whether it is required depends on module settings
- `filter2` (optional, string): Filter 2 values — comma-separated value IDs (see `GET /stuff/filter`). Whether it is required depends on module settings
- `filter3` (optional, string): Filter 3 values — comma-separated value IDs (see `GET /stuff/filter`). Whether it is required depends on module settings
- `hgu_title` (optional, string): Entry SEO-friendly URL. Omitted — the current value is kept
- `screenshot` (optional, string(binary)): Game logo/screenshot — `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp` image. Sent only in `multipart/form-data`. Maximum size — module setting (KB)
- `archive` (optional, string(binary)): Archive file (arbitrary downloadable file). Sent only in `multipart/form-data`. Maximum size is limited by site settings/plan
- `cover` (optional, string(binary)): Entry cover — `jpg`, `jpeg`, `jpe`, `png`, `gif`, `webp` image. Sent only in `multipart/form-data`. Maximum size — the cover setting (KB)
- `cover_delete` (optional, integer enum[0, 1]): 1 — remove the current cover when editing (if one was uploaded); 0 — keep it
- `file1` (optional, string(binary)): Embedded image — slots `file1`, `file2`, …; `multipart/form-data` only. PATCH semantics: a slot without an uploaded file keeps its current image. Remove a slot with `del_imgN=1`.
- `del_img1` (optional, integer enum[0, 1]): 1 — remove embedded image in slot 1. Same for `del_img2`, `del_img3`, …
- `add_date` (optional, string): Publication date and time as `yyyy-mm-dd hh:mm`. Works if the "add date" option is enabled in the control panel
- `uplastmod` (optional, integer enum[0, 1]): 1 — write the current server time into the entry modification date. 0 or omitted — leave the modification date unchanged even if the entry was edited. An arbitrary date cannot be set with this field. The parameter only works for users with full edit rights for the module; for everyone else it is silently ignored. If the entry is published with a future date, that publication date is written as th…
- `meta_title` (optional, string): Meta Title
- `meta_description` (optional, string): Meta Description
- `meta_keywords` (optional, string): Meta Keywords
- `ownurl` (optional, string): Entry custom URL (SEO-friendly)
- `other1` (optional, string): Additional field 1 (max length — site plan limit)
- `other2` (optional, string): Additional field 2 (max length — site plan limit)
- `other3` (optional, string): Additional field 3 (max length — site plan limit)
- `other4` (optional, string): Additional field 4 (max length — site plan limit)
- `other5` (optional, string): Additional field 5 (max length — site plan limit)
- `author` (optional, string): Existing user nickname. Deprecated — use `author_id`. Available to module administrators and editors only.
- `author_id` (optional, integer): User ID — publish entry on their behalf. Takes priority over `author`. Available to module administrators and editors only.

### `DELETE` `/stuff/posts` — Delete entry

Delete entry from module

**Parameters:**
- `id` (query, required, integer): Entry ID

### `POST` `/stuff/tags` — Add/update entry tags

Add, update, or remove entry tags. - To remove all tags, send an empty request - To edit tags, send the full list of tags to keep - To add tags, send existing tags plus new ones Tags are comma-separated.

**Request body** (`application/x-www-form-urlencoded`):
- `id` (required, integer): Entry ID
- `tags` (optional, string): Comma-separated tag list

### `GET` `/stuff/category` — Get category list

Get all categories in the "Online games" module

**Parameters:**
- `id` (query, optional, integer): ID of a specific category

### `POST` `/stuff/category` — Add category

Add new category

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `name` (required, string): Category name
- `description` (optional, string): Category description
- `hgu_title` (optional, string): Category SEO-friendly URL
- `ownurl` (optional, string): Custom category slug (without domain)
- `position` (optional, integer): Category position in the list
- `access2category` (optional, string): Comma-separated group IDs allowed to view the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2add` (optional, string): Comma-separated group IDs allowed to add entries to the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2page` (optional, string): Comma-separated group IDs allowed to view the category page. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `file` (optional, string(binary)): Category image

### `PUT` `/stuff/category` — Edit category

Edit existing category

**Parameters:**
- `id` (query, required, integer): Category ID

**Request body** (`application/x-www-form-urlencoded / multipart/form-data`):
- `name` (optional, string)
- `description` (optional, string)
- `hgu_title` (optional, string)
- `ownurl` (optional, string): Custom category slug (without domain)
- `position` (optional, integer)
- `access2category` (optional, string): Comma-separated group IDs allowed to view the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2add` (optional, string): Comma-separated group IDs allowed to add entries to the category. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `access2page` (optional, string): Comma-separated group IDs allowed to view the category page. System groups: 1 Users, 2 Verified, 3 Moderators, 4 Administrators, 251 Friends, 255 Blocked, 999 Guests
- `file` (optional, string(binary)): Category image

### `DELETE` `/stuff/category` — Delete category

**Parameters:**
- `id` (query, required, integer): Category ID

### `GET` `/stuff/comments` — Get entry comments

Get all comments for a specific entry

**Parameters:**
- `id` (query, required, integer): Entry ID

### `POST` `/stuff/comments` — Add comment

Add comment to entry

**Request body** (`application/x-www-form-urlencoded`):
- `entry_id` (required, integer): Entry ID
- `message` (required, string): Comment text
- `pros` (optional, string): Entry pros
- `cons` (optional, string): Entry cons
- `parent_id` (optional, integer): Parent comment ID (for replies)
- `user_id` (optional, integer): User ID on whose behalf the comment is added. Works only when called by a user with permission to edit all comments.
- `subscribe_to_replies` (optional, string): Subscribe the authenticated user to replies for the entry after adding the comment. Value 0/no does not create a subscription; 1/yes creates a subscription. By default, the subscription is created.

### `PUT` `/stuff/comments` — Edit comment

Edit existing comment

**Parameters:**
- `id` (query, required, integer): Comment ID

**Request body** (`application/x-www-form-urlencoded`):
- `message` (optional, string): Comment text
- `pros` (optional, string): Entry pros
- `cons` (optional, string): Entry cons

### `DELETE` `/stuff/comments` — Delete comment

**Parameters:**
- `id` (query, required, integer): Comment ID

### `GET` `/stuff/filter` — Get filter list

Get all module filters

**Parameters:**
- `filter_id` (query, optional, integer): Filter ID

### `POST` `/stuff/filter` — Add filter

Add new filter

**Request body** (`application/x-www-form-urlencoded`):
- `filter_num` (required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)
- `name` (required, string): Filter name
- `items` (required, string): Values separated by |
- `multiselect` (optional, string enum[True, False]): Multiple selection (yes/no)
- `multi4userdisabled` (optional, string enum[True, False]): Multiple selection for regular users

### `PUT` `/stuff/filter` — Update filter

Update existing filter

**Request body** (`application/x-www-form-urlencoded`):
- `filter_num` (required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)
- `name` (optional, string): New filter name
- `items` (optional, string): New values separated by |
- `multiselect` (optional, string enum[True, False])
- `multi4userdisabled` (optional, string enum[True, False])

### `DELETE` `/stuff/filter` — Delete filter

Delete module filter

**Parameters:**
- `filter_num` (query, required, integer enum[1, 2, 3]): Filter number (1, 2, or 3)

### `GET` `/stuff/fields` — Get module field settings

Shows available module fields

---
## Shop Module

OpenAPI: https://api.ucoz.net/shop-openapi.yaml

**Tags:**
- `Cart`: Cart operations — view, add and update products, remove line items
- `Comments`: Comments on store products
- `Categories`: Category list and product category management
- `Currency`: Store currency and rate settings
- `Balance`: Store user balance — view, top up/deduct, set exact value
- `Orders`: Checkout, order list, status and courier assignment
- `Products`: Product list and details, add, edit, delete, variations, images, stock, counters, and visibility

| Method | Path | Summary |
|---|---|---|
| `GET` | `/shop/basket/` | Get cart contents |
| `POST` | `/shop/basket/` | Add to cart |
| `PUT` | `/shop/basket/` | Update cart item quantity |
| `DELETE` | `/shop/basket/` | Remove product from cart |
| `GET` | `/shop/comments` | Get entry comments |
| `POST` | `/shop/comments` | Add comment |
| `PUT` | `/shop/comments` | Edit comment |
| `DELETE` | `/shop/comments` | Delete comment |
| `GET` | `/shop/request` | Get category list |
| `POST` | `/shop/edit_cat` | Category operations |
| `POST` | `/shop/setcurrrate` | Change store currency rate |
| `GET` | `/shop/getshopdata/` | Get currency list |
| `GET` | `/shop/balance` | Get user balance |
| `POST` | `/shop/balance` | Top up or deduct balance |
| `PUT` | `/shop/balance` | Set exact balance value |
| `GET` | `/shop/checkout/` | Checkout data |
| `POST` | `/shop/checkout/` | Place order |
| `PUT` | `/shop/checkout/` | Recalculate draft order or save order note |
| `GET` | `/shop/invoices/` | Get order list (my orders) |
| `PUT` | `/shop/invoices/hide` | Assign order group |
| `PUT` | `/shop/invoices/setCourier` | Assign courier to order |
| `PUT` | `/shop/invoices/status` | Assign order status |
| `PUT` | `/shop/invoices/change` | Change payment method and restart order payment |
| `GET` | `/shop/order/` | Get specific order |
| `POST` | `/shop/order/` | Add product to order |
| `PUT` | `/shop/order/` | Modify order |
| `PUT` | `/shop/order/delivery_tax` | Update order delivery cost |
| `GET` | `/shop/request/allgoods` | List all products |
| `GET` | `/shop/request/viewgoods` | Product details |
| `POST` | `/shop/addgoods` | Add product |
| `POST` | `/shop/editgoods` | Edit product |
| `POST` | `/shop/editgoods/delete` | Delete product |
| `POST` | `/shop/variation/` | Variation property dictionary |
| `POST` | `/shop/editgoods/variation_gen` | Generate product variation combinations |
| `GET` | `/shop/editgoods/variations` | Load product variations list |
| `GET` | `/shop/editgoods/variation` | Get product variation |
| `PUT` | `/shop/editgoods/variation` | Update product variation |
| `POST` | `/shop/editgoods/hide` | Hide/show product |
| `POST` | `/shop/editgoods/cnt_save` | Save product counters |
| `POST` | `/shop/editgoods/img_add` | Add product image |
| `POST` | `/shop/editgoods/img_edit` | Replace product image |
| `POST` | `/shop/editgoods/img_del` | Delete product image |
| `GET` | `/shop/editgoods/stock_get` | Get stock by options |
| `GET` | `/shop/editgoods/stock_get_genall` | Generate all stock option sets |
| `POST` | `/shop/editgoods/stock_get_add` | Add stock option set |
| `POST` | `/shop/editgoods/stock_get_save` | Save stock option set settings |
| `POST` | `/shop/editgoods/stock_get_removeselected` | Delete selected stock option sets |
| `POST` | `/shop/editgoods/stock_get_removeall` | Delete all stock option sets |

### `GET` `/shop/basket/` — Get cart contents

Shows all products currently in your cart

**Parameters:**
- `user_id` (query, optional, integer): User ID. If set, returns that user's cart. Only applies when the request is made by an administrator.

### `POST` `/shop/basket/` — Add to cart

Add product to cart

**Request body** (`application/x-www-form-urlencoded`):
- `mode` (required, string enum['add'])
- `id` (required, integer): Product ID
- `cnt` (optional, integer): Product quantity (default 1)
- `opt` (optional, string): Selected options string in the "<OPTION_ID>-<ID_SELECTED_VALUE>:<OPTION_ID>-<ID_SELECTED_VALUE>:..." format. When the selected value ID is 0, pass only "<OPTION_ID>" without the "-0" suffix. Example: "2-3:3:4:5-1" (options 3 and 4 have value 0 selected).
- `now` (optional, integer enum[0, 1]): Flag for "Buy now" operation

### `PUT` `/shop/basket/` — Update cart item quantity

Change product quantity in cart

**Request body** (`application/x-www-form-urlencoded`):
- `mode` (required, string enum['put'])
- `id` (required, integer): Cart line item ID
- `cnt` (optional, integer): Product quantity (default 1)
- `opt` (optional, string): Selected options string
- `now` (optional, integer enum[0, 1]): "Buy now" operation flag

### `DELETE` `/shop/basket/` — Remove product from cart

Remove product from cart. If `id` is omitted, the cart is cleared

**Request body** (`application/x-www-form-urlencoded`):
- `id` (optional, integer): Cart line item ID to remove. If omitted, the entire cart is cleared

### `GET` `/shop/comments` — Get entry comments

Get all comments for a specific entry

**Parameters:**
- `id` (query, required, integer): Entry ID

### `POST` `/shop/comments` — Add comment

Add comment to entry

**Request body** (`application/x-www-form-urlencoded`):
- `entry_id` (required, integer): Entry ID
- `message` (required, string): Comment text
- `pros` (optional, string): Entry pros
- `cons` (optional, string): Entry cons
- `parent_id` (optional, integer): Parent comment ID (for replies)
- `user_id` (optional, integer): User ID on whose behalf the comment is added. Works only when called by a user with permission to edit all comments.
- `subscribe_to_replies` (optional, string): Subscribe the authenticated user to replies for the entry after adding the comment. Value 0/no does not create a subscription; 1/yes creates a subscription. By default, the subscription is created.

### `PUT` `/shop/comments` — Edit comment

Edit existing comment

**Parameters:**
- `id` (query, required, integer): Comment ID

**Request body** (`application/x-www-form-urlencoded`):
- `message` (optional, string): Comment text
- `pros` (optional, string): Entry pros
- `cons` (optional, string): Entry cons

### `DELETE` `/shop/comments` — Delete comment

**Parameters:**
- `id` (query, required, integer): Comment ID

### `GET` `/shop/request` — Get category list

Parameter page=categories mimics the $CATEGORIES$ template variable (all categories output)

**Parameters:**
- `page` (query, required, string enum['categories'])
- `parent_id` (query, optional, integer): Parent category ID
- `get_globals` (query, optional, integer enum[0, 1]): Return the list of global store categories

### `POST` `/shop/edit_cat` — Category operations

Add, update, manage category images and visibility

**Request body** (`application/x-www-form-urlencoded`):
- `mode` (required, string enum['add', 'edit', 'img', 'show', 'hide']): Operation mode
- `id` (optional, integer): Category ID (required for mode=edit, mode=img, mode=show, mode=hide)
- `name` (optional, string): Category name (required for mode=add)
- `pid` (optional, integer): Parent category ID
- `global_cat` (optional, integer): Product group category ID
- `dscr` (optional, string): Category description
- `meta_title` (optional, string): HTML page title
- `meta_dscr` (optional, string): HTML meta description
- `url` (optional, string): Category URI (SEO-friendly URL)
- `pos` (optional, integer): Category position in category list
- `cat_img` (optional, string): Path to the file on the server from which the API request is sent
- `view_groups` (optional, string): Comma-separated group IDs allowed to access the category
- `add_groups` (optional, string): Comma-separated group IDs allowed to add entries to the category
- `exclude_from_discount` (optional, integer enum[0, 1]): Toggle category "Exclude from discounts" flag
- `del` (optional, integer enum[0, 1]): Delete image flag (for mode=img). Ignored if "cat_img" is set

### `POST` `/shop/setcurrrate` — Change store currency rate

**Request body** (`application/x-www-form-urlencoded`):
- `curr_code` (required, string): Currency code. Must match a currency code configured in store settings
- `curr_rate` (required, number): Currency rate. Must be non-zero

### `GET` `/shop/getshopdata/` — Get currency list

Get store currency list

**Parameters:**
- `page` (query, required, string enum['currencies_list'])

### `GET` `/shop/balance` — Get user balance

Returns the current user balance ($_SHOP_BALANCE$). Without the `uid` parameter, returns the balance of the user making the request. Another user's balance (`uid` ≠ own) is available only to a user with administrator rights.

**Parameters:**
- `uid` (query, optional, integer): User ID. Applies only if the user making the request has administrator rights. Alias `user_id`

### `POST` `/shop/balance` — Top up or deduct balance

Changes the user balance by `amount` (top up or deduction). **Access:** site owner only, with a Bearer key that has "API access to control panel settings" enabled (`can_use_cp`). Regular store administrator status is not sufficient. The operation is logged in the store transaction journal ("Credits" for top up, "Payouts" for deduction); amount is in store currency units. A deduction that would make the balance negative is rejected with `INCORRECT_PARAMETERS` (check is atomic; balance is not changed).

**Request body** (`application/x-www-form-urlencoded`):
- `uid` (optional, integer): User ID. Default — user making the request. Alias `user_id`
- `amount` (required, number): Change amount. Positive number greater than zero; decimal part allowed with dot or comma
- `action` (required, string enum['add', 'subtract']): Operation direction (required, no default): - `add` — top up balance; - `subtract` — deduct from balance. Case-insensitive. For backward compatibility, `+` (= `add`) and `-` (= `subtract`) are also accepted, but words are recommended. Parameter aliases — `operation` and `sign`.
- `rem` (optional, string): Note for the transaction log entry. Alias `comment`. Default "uAPI balance update"

### `PUT` `/shop/balance` — Set exact balance value

Sets the user balance to an exact value. **Access:** site owner only, with a Bearer key that has "API access to control panel settings" enabled (`can_use_cp`). Regular store administrator status is not sufficient. The difference between the new and old value is logged in the store transaction journal. Setting the same value again (difference 0) does not create a log entry. Negative balance values are not allowed.

**Request body** (`application/x-www-form-urlencoded`):
- `uid` (optional, integer): User ID. Default — user making the request. Alias `user_id`
- `balance` (required, number): New balance value. Non-negative number; decimal part allowed with dot or comma. Aliases `amount` and `value`
- `rem` (optional, string): Note for the transaction log entry. Alias `comment`. Default "uAPI balance update"

### `GET` `/shop/checkout/` — Checkout data

Get data to start checkout

**Parameters:**
- `promo_code` (query, optional, string): Promo code
- `custom_delivery_tax` (query, optional, string): Order delivery fee. Applies if the default delivery method has "Use delivery cost calculation module" enabled and "External calculator" is set

### `POST` `/shop/checkout/` — Place order

**Request body** (`application/x-www-form-urlencoded`):
- `payment_id` (optional, integer): Payment method ID
- `delivery_id` (optional, integer): Delivery method ID
- `promo_code` (optional, string): Promo code
- `custom_delivery_tax` (optional, string): Delivery fee
- `field_N` (optional, string): Order additional field value (N — field number)

### `PUT` `/shop/checkout/` — Recalculate draft order or save order note

Modes: - `recalc` / `edit` — recalculate product or update a draft order; - `inv_note_save` — save a note on an already placed order. For `inv_note_save`, pass the numeric order ID (`id`, not ORDER_HASH) and the `note` text. Read the result in `GET /shop/order/?order={hash}` → `success.order_data.order_note` and in `GET /shop/invoices/?id={id}` → `orders[].note`.

**Request body** (`application/x-www-form-urlencoded`):
- `mode` (required, string enum['recalc', 'edit', 'inv_note_save']): Operation mode: - `recalc` — recalculate draft order; - `edit` — update draft order; - `inv_note_save` — save a note on a placed order.
- `cnt_REC_ID` (optional, integer): Product quantity (for mode=recalc/edit). REC_ID — order line item ID
- `del_REC_ID` (optional, integer enum[0, 1]): Flag to remove a product unit from the order (for mode=recalc/edit). REC_ID — order line item ID
- `id` (optional, integer): Numeric order ID (invoice id), not ORDER_HASH. Required for mode=inv_note_save
- `note` (optional, string): Order note text (for mode=inv_note_save)

### `GET` `/shop/invoices/` — Get order list (my orders)

Get order list with optional filters

**Parameters:**
- `page` (query, optional, integer): Page number
- `user` (query, optional, integer): Filter — user ID who placed the order. Only applies when the request is made by an administrator
- `hide` (query, optional, integer enum[0, 1, 2]): Filter — order group (0 — In progress, 1 — Archived, 2 — In cart)
- `status` (query, optional, integer enum[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]): Filter — order status
- `inv_sum` (query, optional, string): Filter — order amount range as "sum1|sum2"
- `courier` (query, optional, string): Filter — courier
- `cdate` (query, optional, string): Filter — delivery period as "date1|date2" (YYYY-MM-DD HH:MI:SS)
- `payment` (query, optional, integer): Filter — payment method ID
- `delivery` (query, optional, integer): Filter — delivery method ID
- `id` (query, optional, string): Filter — order ID(s), comma-separated
- `date` (query, optional, string): Filter — added date range as "date1|date2" (YYYY-MM-DD HH:MI:SS)

### `PUT` `/shop/invoices/hide` — Assign order group

Assign group to orders

**Request body** (`application/x-www-form-urlencoded`):
- `ids` (required, string): Order ID(s), comma-separated
- `hide` (optional, integer enum[0, 1, 2]): Order group. Possible values: - 0 — "In progress" (default) - 1 — "Archived" - 2 — "In cart"

### `PUT` `/shop/invoices/setCourier` — Assign courier to order

Assign courier to orders

**Request body** (`application/x-www-form-urlencoded`):
- `ids` (required, string): Order ID(s), comma-separated
- `group_courier` (required, string): Courier user login. Login of the user to assign as courier for the order(s).

### `PUT` `/shop/invoices/status` — Assign order status

Assign status to orders

**Request body** (`application/x-www-form-urlencoded`):
- `ids` (required, string): Order ID(s), comma-separated
- `status` (required, integer enum[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]): Order status ID. Possible values: - 0 — New - 1 — Awaiting payment - 2 — Paid - 3 — Processing - 4 — Ready - 5 — Out for delivery - 6 — Delivered to pickup point - 7 — Delivered - 8 — Completed - 9 — Cancelled - 10 — Payment processing - 11 — Prepayment received

### `PUT` `/shop/invoices/change` — Change payment method and restart order payment

Change the payment method of an existing unpaid order and restart its payment. Available to the order owner or a shop administrator/moderator. Parameters are passed in the body (`application/x-www-form-urlencoded`); they also work in the query string. The method returns HTTP 200 both on success and on error: the result is told apart by the `success` or `error` key in the response body (same as the order and courier-change methods).

**Request body** (`application/x-www-form-urlencoded`):
- `order` (required, string): Order hash (ORDER_HASH), as in `/shop/order/`. An `-auth-<key>` suffix is allowed.
- `payment_id` (required, integer): ID of the new payment method (list — `/shop/getshopdata` → `paymentsmethods`). Has an alias `payment`.

### `GET` `/shop/order/` — Get specific order

Get a specific order by its hash

**Parameters:**
- `order` (query, required, string): Order hash (ORDER_HASH)

### `POST` `/shop/order/` — Add product to order

Add a new product to an existing order

**Request body** (`application/x-www-form-urlencoded`):
- `order` (required, string): Order hash (ORDER_HASH)
- `id` (required, integer): Product ID to add to the order
- `opt` (optional, string): Selected options string in the "<OPTION_ID>-<ID_SELECTED_VALUE>:<OPTION_ID>-<ID_SELECTED_VALUE>:..." format. When the selected value ID is 0, pass only "<OPTION_ID>" without the "-0" suffix. Example: "2-3:3:4:5-1" (options 3 and 4 have value 0 selected).

### `PUT` `/shop/order/` — Modify order

Modify order contents, order fields, status, or note

**Request body** (`application/x-www-form-urlencoded`):
- `order` (required, string): Order hash (ORDER_HASH)
- `mode` (required, string enum['goods', 'fields', 'status', 'note'])
- `id` (optional, integer): Order line item ID (for mode=goods when changing options with the opt parameter)
- `opt` (optional, string): Selected options string in the "<OPTION_ID>-<ID_SELECTED_VALUE>:<OPTION_ID>-<ID_SELECTED_VALUE>:..." format (for mode=goods and the specified id parameter). When the selected value ID is 0, pass only "<OPTION_ID>" without the "-0" suffix. Example: "2-3:3:4:5-1" (options 3 and 4 have value 0 selected).
- `opt_REC_ID` (optional, string): Selected options string in the "<OPTION_ID>-<ID_SELECTED_VALUE>:<OPTION_ID>-<ID_SELECTED_VALUE>:..." format (for mode=goods). When the selected value ID is 0, pass only "<OPTION_ID>" without the "-0" suffix. Example: "2-3:3:4:5-1" (options 3 and 4 have value 0 selected). REC_ID — order line item ID.
- `cnt_REC_ID` (optional, integer): Product quantity (for mode=goods). REC_ID — order line item ID
- `del_REC_ID` (optional, integer enum[0, 1]): Flag to remove product unit (for mode=goods). REC_ID — order line item ID
- `field_N` (optional, string): Order additional field value (for mode=fields). N — field number
- `status` (optional, object): Order status ID (for mode=status)
- `note` (optional, string): Order note (for mode=note)

### `PUT` `/shop/order/delivery_tax` — Update order delivery cost

Updates the delivery cost in an existing order and returns the updated order data. The `delivery_tax` parameter is optional. If it is not passed in the request, the delivery cost is not changed and the method returns the current order data. If `delivery_tax` is passed for an order without physical products, the method returns the `DELIVERY_NOT_REQUIRED` error with the message "This product is not physical".

**Request body** (`application/x-www-form-urlencoded`):
- `order` (required, string): Order hash (ORDER_HASH)
- `delivery_tax` (optional, number(float)): Delivery cost. If the parameter is not passed, the current delivery cost is not changed

### `GET` `/shop/request/allgoods` — List all products

Returns all store products paginated with full details. > **Actual URL:** `GET /uapi/shop/request?page=allgoods`

**Parameters:**
- `page` (query, required, string enum['allgoods']): Request type (fixed)
- `pnum` (query, optional, integer): Page number (default 1)
- `sort` (query, optional, string): Sort field: `id`, `art`, `brand`, `name` (default), `price`, `warr`, `weight`, `added_time`, `modified_time`, `num_com`, `rating`, `ordered`, `views`, `solds`, `other#`
- `order` (query, optional, string enum['asc', 'desc']): Sort order: `asc` (default), `desc`
- `f_name` (query, optional, string): Filter by name (Base64 value)
- `f_brand` (query, optional, string): Filter by brand (Base64 value)
- `f_art` (query, optional, string): Filter by SKU (Base64 value)
- `f_price` (query, optional, string): Price filter (Base64; format `MIN|MAX|CURRENCY_CODE`)
- `f_stock` (query, optional, string): Filter by stock (Base64 value)
- `f_status` (query, optional, string): Filter by status (Base64 value)
- `f_warr` (query, optional, string): Filter by warranty (Base64 value)
- `f_weight` (query, optional, string): Filter by weight (Base64 value)

### `GET` `/shop/request/viewgoods` — Product details

Returns full data for a product by ID. > **Actual URL:** `GET /uapi/shop/request?page=viewgoods&id={id}`

**Parameters:**
- `page` (query, required, string enum['viewgoods']): Request type (fixed)
- `id` (query, required, integer): Product ID
- `cnt` (query, optional, integer): Quantity (affects final price)
- `goods_id` (query, optional, integer): Product ID to add to wishlist
- `clear` (query, optional, integer enum[1]): Clear wishlist (pass `1`)

### `POST` `/shop/addgoods` — Add product

Full product creation in the store. Legacy docs require: `method=submit`, `cat_id`, `name`. Also supports product params (prices, stock, meta, options, extra categories, etc.). You cannot pass a variations / SKU combinations array in one field. Flow: `POST /shop/variation/` → `POST /shop/editgoods/variation_gen` → `GET …/variations`. `entry_options` in get/list is often `{}` even when combinations exist — use `GET /shop/editgoods/variations`.

**Request body** (`application/x-www-form-urlencoded`):
- `method` (required, string enum['submit']): Operation mode
- `cat_id` (required, integer): Product category ID
- `name` (required, string): Product name
- `cats_add` (optional, string): Extra category IDs as "[ID1, ID2, ID3,...]"
- `ch_addcat` (optional, integer enum[0, 1]): Use extra categories flag (required with cats_add)
- `brief` (optional, string): Product short description
- `dscr` (optional, string): Product full description
- `html_dscr` (optional, integer enum[0, 1]): Allow HTML in full `dscr` (requires "Allow HTML tags when adding entries" permission).
- `type` (optional, integer enum[0, 1, 2, 3]): Product type (0 — physical, 1 — file, 2 — digital code, 3 — service)
- `price` (optional, number): Product price
- `price_in` (optional, number): Product cost price
- `price_old` (optional, number): Product old price
- `stock` (optional, string): Stock (or expected date)
- `art` (optional, string): Product SKU
- `hide` (optional, integer enum[0, 1]): Hide product flag

### `POST` `/shop/editgoods` — Edit product

Full edit of an existing store product. You cannot pass a variations / SKU combinations array in one field. Flow: `POST /shop/variation/` → `POST /shop/editgoods/variation_gen` → `GET …/variations`. Legacy `method=variation-load|variation-gen|variation-edit-save` — see description of `POST /shop/editgoods/variation_gen`.

**Request body** (`application/x-www-form-urlencoded`):
- `method` (required, string enum['submit']): Operation mode
- `id` (required, integer): Product ID to edit
- `cat_id` (required, integer): Product category ID
- `name` (required, string): Product name
- `brand` (optional, string): Manufacturer
- `brief` (optional, string): Product short description
- `dscr` (optional, string): Product full description
- `undisc` (optional, integer enum[0, 1]): Exclude product from discounts
- `price` (optional, number): Product price
- `price_in` (optional, number): Product cost price
- `price_old` (optional, number): Product old price
- `unit` (optional, string): Unit of measure
- `weight` (optional, number): Product weight
- `art` (optional, string): SKU
- `stock` (optional, string): Stock (or expected date)
- `warr` (optional, string): Warranty
- `type` (optional, integer enum[0, 1, 2, 3]): Product type: 0 — physical, 1 — file, 2 — digital code, 3 — service
- `tags` (optional, string): Product tags (comma-separated)
- `url` (optional, string): Product custom URL (SEO-friendly)
- `meta_title` (optional, string): Product page HTML title
- `meta_dscr` (optional, string): Product page HTML meta description
- `cats_add` (optional, string): Extra category IDs as `[ID1, ID2, ID3,...]`
- `ch_addcat` (optional, integer enum[1]): Has extra categories (required when using `cats_add`)
- `hide` (optional, integer enum[0, 1]): Hide product

### `POST` `/shop/editgoods/delete` — Delete product

Permanently delete product from store. > **Note:** HTTP `DELETE` is not supported on uCoz (returns `400 NOT_SUPPORTED_METHOD`). > Recommended: `POST /shop/editgoods` with `method=delete` and `id` in the body. > Legacy: `GET /shop/editgoods?method=delete&id={id}`. > > **Actual URL:** `POST /uapi/shop/editgoods` (body: `method=delete&id={id}`)

**Request body** (`application/x-www-form-urlencoded`):
- `method` (required, string enum['delete']): Operation mode
- `id` (required, integer): Product ID to delete

### `POST` `/shop/variation/` — Variation property dictionary

CRUD for the global product property catalog (control panel "Product properties": Size, Color, etc.). This is not yet product SKU combinations — define properties first, then `POST /shop/editgoods/variation_gen`. Trailing slash is required: `POST /shop/variation` (without `/`) is not supported. Modes via `mode`: - `add` — create property (`name`, repeated `values=S&values=M&values=L`, not `values[]`) - `edit` — update (`id`, optional `name` / `values`) - `show` — read one property (`id`); no list-all endpoint - `delete` — delete property (`id`) In an `add` response the property `id` may be absent.

**Request body** (`application/x-www-form-urlencoded`):
- `mode` (required, string enum['add', 'edit', 'show', 'delete']): Operation mode
- `id` (optional, integer): Property ID in the dictionary (for `edit` / `show` / `delete`)
- `name` (optional, string): Property name (for `add`; optional for `edit`)
- `values` (optional, array): Property values. Send as a repeated field `values=S&values=M&values=L` (not `values[]`).

### `POST` `/shop/editgoods/variation_gen` — Generate product variation combinations

Attach selected dictionary properties to a product and create all SKU combinations (Cartesian product of values). A repeated call **replaces** the entire combination set. The UI schema shows only the stable `id` field — `var_*` names are dynamic (like `stock_<id>` for stock-by-options) and are documented via description / example, not as fixed properties. **Without `var_*`, combinations are not created** (or a 200 response is empty/useless). Both key types are required: - `var_{propertyId}=1` — property participates in generation - `var{propertyId}_{valueId}=1` — specific value included Example: dictionary has property 7 "Size" (1=S, 2=M) and 8 "Color" (3=Black). Attach to product `id=123` to get S+Black and M+Black: id=123 var_7=1 var7_1=1 var7_2=1 var_8=1 var8_3=1 Resulting combinations…

**Request body** (`application/x-www-form-urlencoded`):
- `id` (required, integer): Product ID (required, but useless without var_*)

### `GET` `/shop/editgoods/variations` — Load product variations list

All SKU combinations for one product. Combinations appear after `POST /shop/editgoods/variation_gen`. Query `id` is required; path `/shop/editgoods/{id}/variations` is not supported on public uAPI.

**Parameters:**
- `id` (query, required, integer): Product ID

### `GET` `/shop/editgoods/variation` — Get product variation

One SKU combination by product `id` and `variation_crc` (from `GET …/variations`). Path `/shop/editgoods/{id}/variation` is not supported on public uAPI.

**Parameters:**
- `id` (query, required, integer): Product ID
- `variation_crc` (query, required, string): Product variation hash (variation_crc)

### `PUT` `/shop/editgoods/variation` — Update product variation

Update fields of an **existing** combination (update, not create/upsert). Creating the set is only via `POST /shop/editgoods/variation_gen`. There is no DELETE for a single combination: shrink the set with a repeated gen and fewer `var_*`.

**Request body** (`application/x-www-form-urlencoded`):
- `id` (required, integer): Product ID
- `variation_crc` (required, string): Product variation hash (variation_crc)
- `art` (optional, string): SKU
- `stock` (optional, integer): Stock
- `price` (optional, number): Price
- `price_old` (optional, number): Old price
- `weight` (optional, number): Weight

### `POST` `/shop/editgoods/hide` — Hide/show product

Toggle product visibility

**Request body** (`application/x-www-form-urlencoded`):
- `id` (required, integer): Product ID
- `hide` (optional, integer enum[0, 1]): 1 — hide, 0 — show. If omitted — toggles current state

### `POST` `/shop/editgoods/cnt_save` — Save product counters

Save product stats — rating, views, sales, orders, stock

**Request body** (`application/x-www-form-urlencoded`):
- `id` (required, integer): Product ID
- `views` (optional, integer): View count
- `solds` (optional, integer): Sales count
- `ordered` (optional, integer): Order placement count
- `rate_num` (optional, integer): Rating vote count
- `rate_sum` (optional, number): Rating sum
- `stock_q` (optional, integer): Stock (when warehouse tracking and total stock enabled)

### `POST` `/shop/editgoods/img_add` — Add product image

Add one or more product images. Multipart/form-data with id and file_add_1, file_add_2, … files (count via file_add_cnt).

**Request body** (`multipart/form-data`):
- `id` (required, integer): Product ID
- `file_add_cnt` (optional, integer): Number of files to upload
- `file_add_1` (optional, string(binary)): Image file 1
- `file_add_2` (optional, string(binary)): Image file 2

### `POST` `/shop/editgoods/img_edit` — Replace product image

Replace product image by index. Request body — multipart/form-data with file for img.

**Request body** (`multipart/form-data`):
- `id` (required, integer): Product ID
- `img` (required, integer): Image index to replace
- `file` (optional, string(binary)): New image file (field name &lt;file_&lt;img&gt;)

### `POST` `/shop/editgoods/img_del` — Delete product image

Delete one or all product images

**Request body** (`application/x-www-form-urlencoded`):
- `id` (required, integer): Product ID
- `img` (optional, integer): Image index to delete. If omitted — del_all is used
- `del_all` (optional, integer enum[0, 1]): Delete all product images
- `files_sequence` (optional, string): Image order (when deleting one image in edit mode)

### `GET` `/shop/editgoods/stock_get` — Get stock by options

Get option set list (stock by options) for product

**Parameters:**
- `id` (query, required, integer): Product ID
- `page` (query, optional, integer): Page number (default 1)

### `GET` `/shop/editgoods/stock_get_genall` — Generate all stock option sets

Generate all option sets for warehouse tracking. Available only when stock tracking and "Stock by options" are enabled.

**Parameters:**
- `id` (query, required, integer): Product ID

### `POST` `/shop/editgoods/stock_get_add` — Add stock option set

Add option set for product warehouse

**Request body** (`application/x-www-form-urlencoded`):
- `id` (required, integer): Product ID
- `opt_sel` (required, string): Selected options as option-value (e.g. opt1-val1:opt2-val2)

### `POST` `/shop/editgoods/stock_get_save` — Save stock option set settings

Save stock and SKUs per option set. Parameters per set (id — shop_stock set ID): stock_&lt;id&gt; (stock), art_&lt;id&gt; (SKU), crc_&lt;id&gt; (set CRC).

**Request body** (`application/x-www-form-urlencoded`):
- `id` (required, integer): Product ID

### `POST` `/shop/editgoods/stock_get_removeselected` — Delete selected stock option sets

Delete selected option sets

**Request body** (`application/x-www-form-urlencoded`):
- `id` (required, integer): Product ID
- `ids` (required, string): Comma-separated set IDs to delete

### `POST` `/shop/editgoods/stock_get_removeall` — Delete all stock option sets

Delete all product option sets

**Request body** (`application/x-www-form-urlencoded`):
- `id` (required, integer): Product ID

---
## Subscriptions Module

OpenAPI: https://api.ucoz.net/subscriptions-openapi.yaml

API documentation for the uCoz Subscriptions module. All requests require a Bearer token with access to Control Panel settings enabled.

**Tags:**
- `Plans`: Manage plans.
- `Subscriptions`: Manage user subscriptions.
- `Access check`: Check a user's access to a plan.
- `Payments`: Work with subscription payments.
- `Deprecated routes`: Routes retained for backward compatibility. New integrations should use the replacement routes in the main sections.

| Method | Path | Summary |
|---|---|---|
| `GET` | `/subscriptions/items` | List plans (deprecated route) |
| `GET` | `/subscriptions/item` | Get a plan (deprecated route) |
| `POST` | `/subscriptions/item` | Create a plan (deprecated route) |
| `PUT` | `/subscriptions/item` | Update a plan (deprecated route) |
| `DELETE` | `/subscriptions/item` | Delete a plan (deprecated route) |
| `GET` | `/subscriptions/plans` | List plans |
| `POST` | `/subscriptions/plans` | Create a plan |
| `GET` | `/subscriptions/plans/{plan_id}` | Get a plan |
| `PUT` | `/subscriptions/plans/{plan_id}` | Update a plan |
| `DELETE` | `/subscriptions/plans/{plan_id}` | Delete a plan |
| `POST` | `/subscriptions/plans/{plan_id}/enable` | Enable a plan |
| `POST` | `/subscriptions/plans/{plan_id}/disable` | Disable a plan |
| `GET` | `/subscriptions/plans/{plan_id}/stats` | Get plan statistics |
| `GET` | `/subscriptions/plans/{plan_id}/users` | List plan users |
| `POST` | `/subscriptions` | Create an unpaid subscription |
| `POST` | `/subscriptions/grant` | Grant a subscription |
| `POST` | `/subscriptions/trial` | Start a trial |
| `GET` | `/subscriptions/user/{user_id}` | Get user subscriptions |
| `GET` | `/subscriptions/{subscription_id}` | Get a subscription |
| `POST` | `/subscriptions/{subscription_id}/renew` | Renew a subscription |
| `POST` | `/subscriptions/{subscription_id}/change-plan` | Change a subscription plan |
| `POST` | `/subscriptions/{subscription_id}/pause` | Pause a subscription |
| `POST` | `/subscriptions/{subscription_id}/resume` | Resume a subscription |
| `POST` | `/subscriptions/{subscription_id}/cancel` | Cancel a subscription |
| `POST` | `/subscriptions/{subscription_id}/autorenew/enable` | Enable auto-renewal |
| `POST` | `/subscriptions/{subscription_id}/autorenew/disable` | Disable auto-renewal |
| `GET` | `/subscriptions/access` | Check user access to a plan |
| `GET` | `/subscriptions/subscribers` | List subscribers |
| `GET` | `/subscriptions/payments` | List payments |
| `POST` | `/subscriptions/payments` | Create an internal payment record |
| `GET` | `/subscriptions/payments/{payment_id}` | Get a payment |
| `POST` | `/subscriptions/payments/{payment_id}/confirm` | Confirm a payment |
| `POST` | `/subscriptions/payments/{payment_id}/refund` | Refund a payment |

### `GET` `/subscriptions/items` — List plans (deprecated route)

Backward-compatible legacy route. New integrations should use GET /subscriptions/plans.

### `GET` `/subscriptions/item` — Get a plan (deprecated route)

Backward-compatible legacy route. New integrations should use GET /subscriptions/plans/{plan_id}.

**Parameters:**
- `id` (query, required, integer): Plan ID for the deprecated route

### `POST` `/subscriptions/item` — Create a plan (deprecated route)

Backward-compatible legacy route. New integrations should use POST /subscriptions/plans.

**Request body** (`application/x-www-form-urlencoded`):
- `title` (required, string): Plan title
- `description` (optional, string): Plan description
- `type` (required, integer enum[0, 1, 2, 3]): Type: 0 — free, 1 — one-time, 2 — recurring, 3 — donation
- `price` (optional, number(float)): Price in major currency units
- `price_old` (optional, number(float)): Previous price in major currency units
- `is_discount` (optional, integer enum[0, 1]): Discount flag
- `is_advantage` (optional, integer enum[0, 1]): Display the plan benefit text
- `interval` (optional, integer): Subscription interval in days
- `period` (optional, integer): Recurring renewal period in days
- `trial_interval` (optional, integer): Trial duration in days
- `group_to` (optional, integer): Target user group ID
- `group_back` (optional, integer): User group ID after subscription expiry
- `text_advantage` (optional, string): Plan benefit text
- `advantage_items` (optional, string): Benefits separated by line breaks

### `PUT` `/subscriptions/item` — Update a plan (deprecated route)

Backward-compatible legacy route. New integrations should use PUT /subscriptions/plans/{plan_id}; send the complete plan parameter set.

**Parameters:**
- `id` (query, required, integer): Plan ID for the deprecated route

**Request body** (`application/x-www-form-urlencoded`):
- `title` (required, string): Plan title
- `description` (optional, string): Plan description
- `type` (required, integer enum[0, 1, 2, 3]): Type: 0 — free, 1 — one-time, 2 — recurring, 3 — donation
- `price` (optional, number(float)): Price in major currency units
- `price_old` (optional, number(float)): Previous price in major currency units
- `is_discount` (optional, integer enum[0, 1]): Discount flag
- `is_advantage` (optional, integer enum[0, 1]): Display the plan benefit text
- `interval` (optional, integer): Subscription interval in days
- `period` (optional, integer): Recurring renewal period in days
- `trial_interval` (optional, integer): Trial duration in days
- `group_to` (optional, integer): Target user group ID
- `group_back` (optional, integer): User group ID after subscription expiry
- `text_advantage` (optional, string): Plan benefit text
- `advantage_items` (optional, string): Benefits separated by line breaks

### `DELETE` `/subscriptions/item` — Delete a plan (deprecated route)

Backward-compatible legacy route. New integrations should use DELETE /subscriptions/plans/{plan_id}.

**Parameters:**
- `id` (query, required, integer): Plan ID for the deprecated route

### `GET` `/subscriptions/plans` — List plans

### `POST` `/subscriptions/plans` — Create a plan

**Request body** (`application/x-www-form-urlencoded`):
- `title` (required, string): Plan title
- `description` (optional, string): Plan description
- `type` (required, integer enum[0, 1, 2, 3]): Type: 0 — free, 1 — one-time, 2 — recurring, 3 — donation
- `price` (optional, number(float)): Price in major currency units
- `price_old` (optional, number(float)): Previous price in major currency units
- `is_discount` (optional, integer enum[0, 1]): Discount flag
- `is_advantage` (optional, integer enum[0, 1]): Display the plan benefit text
- `interval` (optional, integer): Subscription interval in days
- `period` (optional, integer): Recurring renewal period in days
- `trial_interval` (optional, integer): Trial duration in days
- `group_to` (optional, integer): Target user group ID
- `group_back` (optional, integer): User group ID after subscription expiry
- `text_advantage` (optional, string): Plan benefit text
- `advantage_items` (optional, string): Benefits separated by line breaks

### `GET` `/subscriptions/plans/{plan_id}` — Get a plan

**Parameters:**
- `plan_id` (path, required, integer): Plan ID

### `PUT` `/subscriptions/plans/{plan_id}` — Update a plan

Send the complete plan parameter set: PUT is not a partial update (PATCH).

**Parameters:**
- `plan_id` (path, required, integer): Plan ID

**Request body** (`application/x-www-form-urlencoded`):
- `title` (required, string): Plan title
- `description` (optional, string): Plan description
- `type` (required, integer enum[0, 1, 2, 3]): Type: 0 — free, 1 — one-time, 2 — recurring, 3 — donation
- `price` (optional, number(float)): Price in major currency units
- `price_old` (optional, number(float)): Previous price in major currency units
- `is_discount` (optional, integer enum[0, 1]): Discount flag
- `is_advantage` (optional, integer enum[0, 1]): Display the plan benefit text
- `interval` (optional, integer): Subscription interval in days
- `period` (optional, integer): Recurring renewal period in days
- `trial_interval` (optional, integer): Trial duration in days
- `group_to` (optional, integer): Target user group ID
- `group_back` (optional, integer): User group ID after subscription expiry
- `text_advantage` (optional, string): Plan benefit text
- `advantage_items` (optional, string): Benefits separated by line breaks

### `DELETE` `/subscriptions/plans/{plan_id}` — Delete a plan

A plan cannot be deleted while it has active subscriptions.

**Parameters:**
- `plan_id` (path, required, integer): Plan ID

### `POST` `/subscriptions/plans/{plan_id}/enable` — Enable a plan

**Parameters:**
- `plan_id` (path, required, integer): Plan ID

### `POST` `/subscriptions/plans/{plan_id}/disable` — Disable a plan

**Parameters:**
- `plan_id` (path, required, integer): Plan ID

### `GET` `/subscriptions/plans/{plan_id}/stats` — Get plan statistics

**Parameters:**
- `plan_id` (path, required, integer): Plan ID

### `GET` `/subscriptions/plans/{plan_id}/users` — List plan users

**Parameters:**
- `plan_id` (path, required, integer): Plan ID
- `p` (query, optional, integer): Page number
- `status` (query, optional, string): Status or a comma-separated list: 0 — unpaid, 1 — active, 2 — trial, 3 — canceled, 4 — paused
- `expires_before` (query, optional, integer(int64)): Upper end-date limit as a Unix timestamp

### `POST` `/subscriptions` — Create an unpaid subscription

**Request body** (`application/x-www-form-urlencoded`):
- `user_id` (required, integer): User ID
- `plan_id` (required, integer): Plan ID

### `POST` `/subscriptions/grant` — Grant a subscription

Creates and immediately activates a subscription without creating a payment.

**Request body** (`application/x-www-form-urlencoded`):
- `user_id` (required, integer): User ID
- `plan_id` (required, integer): Plan ID

### `POST` `/subscriptions/trial` — Start a trial

Available for a recurring plan with a configured trial duration.

**Request body** (`application/x-www-form-urlencoded`):
- `user_id` (required, integer): User ID
- `plan_id` (required, integer): Plan ID

### `GET` `/subscriptions/user/{user_id}` — Get user subscriptions

**Parameters:**
- `user_id` (path, required, integer): User ID
- `p` (query, optional, integer): Page number
- `status` (query, optional, string): Status or a comma-separated list: 0 — unpaid, 1 — active, 2 — trial, 3 — canceled, 4 — paused
- `expires_before` (query, optional, integer(int64)): Upper end-date limit as a Unix timestamp

### `GET` `/subscriptions/{subscription_id}` — Get a subscription

**Parameters:**
- `subscription_id` (path, required, integer): Subscription ID

### `POST` `/subscriptions/{subscription_id}/renew` — Renew a subscription

**Parameters:**
- `subscription_id` (path, required, integer): Subscription ID

### `POST` `/subscriptions/{subscription_id}/change-plan` — Change a subscription plan

**Parameters:**
- `subscription_id` (path, required, integer): Subscription ID

**Request body** (`application/x-www-form-urlencoded`):
- `plan_id` (required, integer): ID of the new plan

### `POST` `/subscriptions/{subscription_id}/pause` — Pause a subscription

Suspends access and preserves the subscription end date.

**Parameters:**
- `subscription_id` (path, required, integer): Subscription ID

### `POST` `/subscriptions/{subscription_id}/resume` — Resume a subscription

**Parameters:**
- `subscription_id` (path, required, integer): Subscription ID

### `POST` `/subscriptions/{subscription_id}/cancel` — Cancel a subscription

Immediately cancels the subscription and revokes user access.

**Parameters:**
- `subscription_id` (path, required, integer): Subscription ID

### `POST` `/subscriptions/{subscription_id}/autorenew/enable` — Enable auto-renewal

Requires saved payment authorization.

**Parameters:**
- `subscription_id` (path, required, integer): Subscription ID

### `POST` `/subscriptions/{subscription_id}/autorenew/disable` — Disable auto-renewal

Access remains available until the current subscription end date.

**Parameters:**
- `subscription_id` (path, required, integer): Subscription ID

### `GET` `/subscriptions/access` — Check user access to a plan

**Parameters:**
- `user_id` (query, required, integer): User ID
- `plan_id` (query, required, integer): Plan ID

### `GET` `/subscriptions/subscribers` — List subscribers

**Parameters:**
- `p` (query, optional, integer): Page number
- `query` (query, optional, string): Search by user ID, subscription ID or UUID, or email
- `plan_id` (query, optional, integer): Filter by plan ID
- `status` (query, optional, string): Status or a comma-separated list: 0 — unpaid, 1 — active, 2 — trial, 3 — canceled, 4 — paused
- `expires_before` (query, optional, integer(int64)): Upper end-date limit as a Unix timestamp

### `GET` `/subscriptions/payments` — List payments

**Parameters:**
- `p` (query, optional, integer): Page number
- `query` (query, optional, string): Search by user ID, transaction_id, or email
- `user_id` (query, optional, integer): Filter by user ID
- `subscription_id` (query, optional, integer): Filter by subscription ID
- `status` (query, optional, string): Status or a comma-separated list: pending, paid, canceled, refund, waiting, or codes 0–4
- `date_from` (query, optional, integer(int64)): Lower payment-date limit as a Unix timestamp
- `date_to` (query, optional, integer(int64)): Upper payment-date limit as a Unix timestamp

### `POST` `/subscriptions/payments` — Create an internal payment record

Creates a pending internal record and does not initiate a payment with a payment provider.

**Request body** (`application/x-www-form-urlencoded`):
- `subscription_id` (required, integer): Subscription ID
- `amount` (required, integer): Amount in minor currency units
- `payment_method_id` (optional, integer): ID of an available payment method
- `currency` (optional, string): ISO 4217 currency code
- `transaction_id` (optional, string): Idempotency identifier for payment creation

### `GET` `/subscriptions/payments/{payment_id}` — Get a payment

**Parameters:**
- `payment_id` (path, required, integer): Payment ID

### `POST` `/subscriptions/payments/{payment_id}/confirm` — Confirm a payment

Administratively confirms the internal record and activates or renews the subscription.

**Parameters:**
- `payment_id` (path, required, integer): Payment ID

### `POST` `/subscriptions/payments/{payment_id}/refund` — Refund a payment

Requests a refund from the payment provider for a confirmed payment that has a provider transaction. An internal record created through the API without such a transaction cannot be refunded by this method.

**Parameters:**
- `payment_id` (path, required, integer): Payment ID

---
## Templates

OpenAPI: https://api.ucoz.net/templates-openapi.yaml

API for working with uCoz site templates. ## Template Maker (tmaker) Methods that accept a skeleton (`export`, `validate`, `archive`, `projects`) support only `multipart/form-data`. Send the `tmpl` field as plain text — no URL-encoding and no single-line JSON escaping. ## Bearer Token authorization All API requests require Bearer token authorization. To use the API you need to: 1. Get a [Bearer token](/en/start.html) (access token) 2. Specify your site domain in the "Server" field below 3. Ente…

| Method | Path | Summary |
|---|---|---|
| `GET` | `/templates` | List modules and templates |
| `GET` | `/templates/{module_id}/{template_id}` | Get template |
| `POST` | `/templates/{module_id}/{template_id}` | Save template (PUT alternative) |
| `PUT` | `/templates/{module_id}/{template_id}` | Save template (full or partial) |
| `POST` | `/templates/{module_id}/{template_id}/restore` | Restore default template |
| `GET` | `/templates/backup` | List template backups |
| `POST` | `/templates/backup` | Create template backup |
| `DELETE` | `/templates/backup/{id}` | Delete template backup |
| `POST` | `/templates/backup/{id}/restore` | Restore templates from backup |
| `POST` | `/tmaker/export` | Publish skeleton as site templates |
| `POST` | `/tmaker/validate` | Validate skeleton without publishing |
| `GET` | `/tmaker/rules` | Skeleton code reference |
| `GET` | `/tmaker/designs` | List standard designs or get one design |
| `POST` | `/tmaker/archive` | Create skeleton ZIP archive |
| `GET` | `/tmaker/projects` | List saved projects or get one project |
| `POST` | `/tmaker/projects` | Save a new project |
| `PUT` | `/tmaker/projects` | Save project and set it active |
| `DELETE` | `/tmaker/projects/{id}` | Delete a saved project |

### `GET` `/templates` — List modules and templates

Returns site modules and templates tree (same as main templates panel list).

### `GET` `/templates/{module_id}/{template_id}` — Get template

Returns template code and available variables for the template.

**Parameters:**
- `module_id` (path, required, string): Module ID (numeric)
- `template_id` (path, required, string): Template ID (0, 1, 2, … or string identifier)

### `POST` `/templates/{module_id}/{template_id}` — Save template (PUT alternative)

Same as PUT — saves template code: full replacement (content) or partial replacement (mode=partial_replace + code_search/code_paste).

**Parameters:**
- `module_id` (path, required, string)
- `template_id` (path, required, string)
- `mode` (query, optional, string enum['full_replace', 'partial_replace']): Save mode. Fill fields for ONLY ONE mode: - `full_replace` (default) — full replacement, pass `content`; - `partial_replace` — partial replacement, pass `code_search` and `code_paste`. Missing `mode` means full replacement. Any other value returns `INVALID_MODE` (400).
- `content` (query, optional, string): [Full replacement] The entire template code (HTML/builder code). Used without mode or with mode=full_replace. Do not combine with code_search/code_paste.
- `code_search` (query, optional, string): [Partial replacement] Exact fragment of the CURRENT template code to search for (with mode=partial_replace). Comparison is byte-for-byte: spaces, tabs, and line breaks are significant. The fragment must occur exactly once, otherwise 409 is returned: zero matches — MATCH_NOT_FOUND, more than one — AMBIGUOUS_MATCH. It is convenient to copy this value from the content field of the GET response.
- `code_paste` (query, optional, string): [Partial replacement] New fragment that replaces code_search (with mode=partial_replace). Empty string removes the matched fragment.

### `PUT` `/templates/{module_id}/{template_id}` — Save template (full or partial)

Saves template code in one of two modes: full replacement (content) or partial fragment replacement (mode=partial_replace + code_search/code_paste). Content validation is the same as in the templates panel.

**Parameters:**
- `module_id` (path, required, string)
- `template_id` (path, required, string)
- `mode` (query, optional, string enum['full_replace', 'partial_replace']): Save mode. Fill fields for ONLY ONE mode: - `full_replace` (default) — full replacement, pass `content`; - `partial_replace` — partial replacement, pass `code_search` and `code_paste`. Missing `mode` means full replacement. Any other value returns `INVALID_MODE` (400).
- `content` (query, optional, string): [Full replacement] The entire template code (HTML/builder code). Used without mode or with mode=full_replace. Do not combine with code_search/code_paste.
- `code_search` (query, optional, string): [Partial replacement] Exact fragment of the CURRENT template code to search for (with mode=partial_replace). Comparison is byte-for-byte: spaces, tabs, and line breaks are significant. The fragment must occur exactly once, otherwise 409 is returned: zero matches — MATCH_NOT_FOUND, more than one — AMBIGUOUS_MATCH. It is convenient to copy this value from the content field of the GET response.
- `code_paste` (query, optional, string): [Partial replacement] New fragment that replaces code_search (with mode=partial_replace). Empty string removes the matched fragment.

### `POST` `/templates/{module_id}/{template_id}/restore` — Restore default template

Resets template to factory default.

**Parameters:**
- `module_id` (path, required, string)
- `template_id` (path, required, string)

### `GET` `/templates/backup` — List template backups

Returns template backup archives (_tbkp files). Limit is set in site settings.

### `POST` `/templates/backup` — Create template backup

Creates archive of current templates (like “Backup templates” in panel). Filename — Unix timestamp.

### `DELETE` `/templates/backup/{id}` — Delete template backup

Deletes backup archive by id (filename without .zip).

**Parameters:**
- `id` (path, required, integer): Backup ID (filename without .zip)

### `POST` `/templates/backup/{id}/restore` — Restore templates from backup

Restores all templates from the backup archive (overwrites current).

**Parameters:**
- `id` (path, required, integer): Backup ID (filename without .zip)

### `POST` `/tmaker/export` — Publish skeleton as site templates

Validates the submitted skeleton (popup markers, balanced `if`/`endif` conditions, duplicate placeholder codes, disk quota, length, required `$POWERED_BY$` code, legacy `{IF}` model) and, when valid, installs it as the site's live templates. Request body — `multipart/form-data` only; send `tmpl` as plain text. Available only to the site owner with permission to use the control panel.

**Request body** (`multipart/form-data`):
- `tmpl` (required, string): Skeleton HTML (plain text). Sent only in multipart/form-data.
- `pda` (optional, integer enum[0, 1]): Install the skeleton as the mobile (PDA) layout instead of desktop. Default: `0`.

### `POST` `/tmaker/validate` — Validate skeleton without publishing

Runs the same checks as `POST /tmaker/export` but does not change site templates — useful before publishing. Request body — `multipart/form-data` only; send `tmpl` as plain text. Available only to the site owner with permission to use the control panel.

**Request body** (`multipart/form-data`):
- `tmpl` (required, string): Skeleton HTML (plain text). Sent only in multipart/form-data.

### `GET` `/tmaker/rules` — Skeleton code reference

Returns a reference of placeholder codes and hints for skeleton authors (same content as the Template Maker sidebar in the control panel). Available only to the site owner with permission to use the control panel.

### `GET` `/tmaker/designs` — List standard designs or get one design

Without `id`, returns available standard designs with an `installed` flag indicating whether the design is currently active on the site. With `id`, returns the HTML skeleton of the selected design with resolved style and image URLs. Available only to the site owner with permission to use the control panel.

**Parameters:**
- `id` (query, optional, integer): Numeric standard design ID (greater than 100). If omitted, the list is returned.

### `POST` `/tmaker/archive` — Create skeleton ZIP archive

Packages the submitted skeleton with images and CSS into a ZIP file in the site's public directory and returns a download URL. Request body — `multipart/form-data` only; send `tmpl` as plain text. The request may take a long time if the skeleton references external images or styles over HTTP. Available only to the site owner with permission to use the control panel.

**Request body** (`multipart/form-data`):
- `tmpl` (required, string): Skeleton HTML (plain text). Sent only in multipart/form-data.

### `GET` `/tmaker/projects` — List saved projects or get one project

Without `id`, returns saved skeleton snapshots with an `active` flag indicating whether the project is active on the site. With `id`, returns the HTML skeleton of the selected project. Available only to the site owner with permission to use the control panel.

**Parameters:**
- `id` (query, optional, integer): Saved project ID (creation Unix timestamp, greater than 100000). If omitted, the list is returned.

### `POST` `/tmaker/projects` — Save a new project

Saves the submitted skeleton as a new snapshot without changing which project is active on the site. Request body — `multipart/form-data` only; send `tmpl` as plain text. Available only to the site owner with permission to use the control panel.

**Request body** (`multipart/form-data`):
- `tmpl` (required, string): Skeleton HTML (plain text). Sent only in multipart/form-data.

### `PUT` `/tmaker/projects` — Save project and set it active

Saves the submitted skeleton as a new snapshot and marks it as the site's active project. Request body — `multipart/form-data` only; send `tmpl` as plain text. Available only to the site owner with permission to use the control panel.

**Request body** (`multipart/form-data`):
- `tmpl` (required, string): Skeleton HTML (plain text). Sent only in multipart/form-data.

### `DELETE` `/tmaker/projects/{id}` — Delete a saved project

Deletes a saved skeleton snapshot by ID. If the deleted project was active, the active project reference is cleared. Deleting a non-existent ID is not treated as an error. Available only to the site owner with permission to use the control panel.

**Parameters:**
- `id` (path, required, integer): Saved project ID (creation Unix timestamp)

---
## Global Blocks

OpenAPI: https://api.ucoz.net/gblocks-openapi.yaml

| Method | Path | Summary |
|---|---|---|
| `GET` | `/gblocks` | Get global block list |
| `POST` | `/gblocks` | Create global block |
| `GET` | `/gblocks/{gblock_id}` | Get global block HTML |
| `POST` | `/gblocks/{gblock_id}` | Save global block HTML (POST alias) |
| `PUT` | `/gblocks/{gblock_id}` | Save global block HTML |
| `DELETE` | `/gblocks/{gblock_id}` | Delete global block |

### `GET` `/gblocks` — Get global block list

Returns a list of all site global blocks.

**Parameters:**
- `pda` (query, optional, integer): Optional; if truthy, use the PDA template tree (t/pda/).

### `POST` `/gblocks` — Create global block

Creates a new global block.

**Request body** (`application/x-www-form-urlencoded`):
- `id` (required, string): Block ID (sanitized to A–Z).
- `content` (optional, string): Initial HTML content.
- `pda` (optional, integer): PDA version flag (0 or 1).

### `GET` `/gblocks/{gblock_id}` — Get global block HTML

Returns the content of a specific global block.

**Parameters:**
- `gblock_id` (path, required, string): Global block ID (A–Z, up to 10 characters).
- `pda` (query, optional, integer): Optional; if truthy, use the PDA template tree (t/pda/).

### `POST` `/gblocks/{gblock_id}` — Save global block HTML (POST alias)

Alternative save method via POST.

**Parameters:**
- `gblock_id` (path, required, string): Global block ID (A–Z, up to 10 characters).

**Request body** (`application/x-www-form-urlencoded`):
- `content` (required, string): HTML content to save.
- `pda` (optional, integer): PDA version flag.

### `PUT` `/gblocks/{gblock_id}` — Save global block HTML

Updates global block content.

**Parameters:**
- `gblock_id` (path, required, string): Global block ID (A–Z, up to 10 characters).

**Request body** (`application/x-www-form-urlencoded`):
- `content` (required, string): HTML content to save.
- `pda` (optional, integer): PDA version flag.

### `DELETE` `/gblocks/{gblock_id}` — Delete global block

Deletes the global block file.

**Parameters:**
- `gblock_id` (path, required, string): Global block ID (A–Z, up to 10 characters).
- `pda` (query, optional, integer): Optional; if truthy, use the PDA template tree (t/pda/).

---
## Menu builder

OpenAPI: https://api.ucoz.net/menus-openapi.yaml

**Tags:**
- `Menu`: Menu operations (create, read, update, delete)
- `Menu items`: Manage menu items and structure

| Method | Path | Summary |
|---|---|---|
| `GET` | `/menus` | Get all menus |
| `POST` | `/menus` | Create menu |
| `GET` | `/menus/{id}` | Get menu with all items |
| `PUT` | `/menus/{id}` | Update menu info |
| `DELETE` | `/menus/{id}` | Delete menu |
| `PUT` | `/menus/{id}/items` | Replace all menu items |

### `GET` `/menus` — Get all menus

Returns a list of all site menus with basic information

### `POST` `/menus` — Create menu

Creates a new menu with the given title and layout

**Request body** (`application/json`):
- `title` (required, string): Menu title
- `layout` (optional, integer enum[0, 1]): 0 = horizontal, 1 = vertical Default: `0`.

### `GET` `/menus/{id}` — Get menu with all items

Returns the full menu with all items and nested structure

**Parameters:**
- `id` (path, required, integer): Menu ID

### `PUT` `/menus/{id}` — Update menu info

Updates menu title or layout. Does not affect menu items.

**Parameters:**
- `id` (path, required, integer): Menu ID

**Request body** (`application/json`):
- `title` (optional, string): New menu title
- `layout` (optional, integer enum[0, 1]): 0 = horizontal, 1 = vertical

### `DELETE` `/menus/{id}` — Delete menu

Deletes the menu and all its items. This cannot be undone.

**Parameters:**
- `id` (path, required, integer): Menu ID

### `PUT` `/menus/{id}/items` — Replace all menu items

Fully replaces the menu item structure. Previous items are removed.

**Parameters:**
- `id` (path, required, integer): Menu ID

**Request body** (`application/json`):
- `items` (required, array): New menu item structure

---
## Module settings

OpenAPI: https://api.ucoz.net/settings-openapi.yaml

| Method | Path | Summary |
|---|---|---|
| `GET` | `/news/setup` | Get site news module settings |
| `PUT` | `/news/setup` | Update site news module settings |
| `GET` | `/blog/setup` | Get blog module settings |
| `PUT` | `/blog/setup` | Update blog module settings |
| `GET` | `/board/setup` | Get classifieds board module settings |
| `PUT` | `/board/setup` | Update classifieds board module settings |
| `GET` | `/publ/setup` | Get article catalog module settings |
| `PUT` | `/publ/setup` | Update article catalog module settings |
| `GET` | `/load/setup` | Get file catalog module settings |
| `PUT` | `/load/setup` | Update file catalog module settings |
| `GET` | `/video/setup` | Get video module settings |
| `PUT` | `/video/setup` | Update video module settings |
| `GET` | `/photo/setup` | Get photo album module settings |
| `PUT` | `/photo/setup` | Update photo album module settings |
| `GET` | `/faq/setup` | Get FAQ module settings |
| `PUT` | `/faq/setup` | Update FAQ module settings |
| `GET` | `/gb/setup` | Get guestbook module settings |
| `PUT` | `/gb/setup` | Update guestbook module settings |
| `GET` | `/dir/setup` | Get site catalog module settings |
| `PUT` | `/dir/setup` | Update site catalog module settings |
| `GET` | `/stuff/setup` | Get online games module settings |
| `PUT` | `/stuff/setup` | Update online games module settings |
| `GET` | `/forum/setup` | Get forum module settings |
| `PUT` | `/forum/setup` | Update forum module settings |
| `GET` | `/tests/setup` | Get tests module settings |
| `PUT` | `/tests/setup` | Update tests module settings |
| `GET` | `/mchat/setup` | Get mini-chat settings |
| `PUT` | `/mchat/setup` | Update mini-chat settings |
| `GET` | `/polls/setup` | Get polls module settings |
| `PUT` | `/polls/setup` | Update polls module settings |
| `GET` | `/search/setup` | Get site search settings |
| `PUT` | `/search/setup` | Update site search settings |
| `GET` | `/seo/setup` | Get SEO module settings |
| `PUT` | `/seo/setup` | Update SEO module settings |
| `GET` | `/site/setup` | Get main site settings |
| `PUT` | `/site/setup` | Update main site settings |

### `GET` `/news/setup` — Get site news module settings

Returns all current site news module settings

### `PUT` `/news/setup` — Update site news module settings

Updates site news module settings. Supports partial updates — only sent parameters are updated; others stay unchanged. The PUT response matches GET and contains the full current settings.

**Request body** (`application/json`):
- `name` (optional, string): Module name
- `top_enabled` (optional, boolean): Top block enabled
- `top_category` (optional, integer): Top category
- `top_name` (optional, string): Top name
- `top_description` (optional, string): Top description
- `categories_columns` (optional, integer): Category column count
- `categories_show_numbers` (optional, boolean): Show category numbers
- `categories_show_global_description` (optional, boolean): Show global category description
- `categories_show_category_description` (optional, boolean): Show category descriptions
- `entries_per_page` (optional, integer): Entries per page
- `entries_per_group` (optional, integer): Entries per group
- `entries_per_category` (optional, integer): Entries per category
- `entries_per_archive` (optional, integer): Entries in archive
- `entries_per_top` (optional, integer): Entries in top block
- `entries_per_rss` (optional, integer): Entries in RSS
- `switch` (optional, integer): Display toggle
- `comments_enabled` (optional, boolean): Comments enabled
- `comments_per_page` (optional, integer): Comments per page
- `comments_top_first` (optional, boolean): Show comments at top
- `sorting_main` (optional, integer): Home page sort order
- `sorting_section` (optional, integer): Section sort order
- `sorting_category` (optional, integer): Category sort order
- `sorting_user_entries` (optional, integer): User entries sort order
- `email_new_entry` (optional, boolean): Email notifications for new entries
- `email_new_comment` (optional, boolean): Email notifications for new comments
- `rating` (optional, boolean): Rating enabled
- `fields` (optional, array): Entry field settings
- `entry_split_enabled` (optional, boolean): Entry split enabled
- `entry_split_symbols` (optional, integer): Split character count
- `http_prefix_4` (optional, boolean): http:// prefix for field 4
- `http_prefix_5` (optional, boolean): http:// prefix for field 5
- `http_prefix_6` (optional, boolean): http:// prefix for field 6
- `http_prefix_7` (optional, boolean): http:// prefix for field 7
- `http_prefix_8` (optional, boolean): http:// prefix for field 8
- `images_max_count` (optional, integer): Maximum image count
- `images_thumb_width` (optional, integer): Thumbnail width
- `images_thumb_height` (optional, integer): Thumbnail height
- `images_full_width` (optional, integer): Full image width
- `images_full_height` (optional, integer): Full image height
- `images_max_size_kb` (optional, integer): Maximum image size in KB
- `images_jpg_quality` (optional, integer): JPG quality
- `images_loading_type` (optional, string enum['eager', 'lazy']): Image loading type
- `cover_enabled` (optional, boolean): Entry cover field enabled
- `cover_required` (optional, boolean): Cover required
- `cover_thumb_width` (optional, integer): Cover thumbnail width
- `cover_thumb_height` (optional, integer): Cover thumbnail height
- `cover_full_width` (optional, integer): Cover full image width
- `cover_full_height` (optional, integer): Cover full image height
- `cover_max_size_kb` (optional, integer): Maximum cover file size in KB
- `cover_quality` (optional, integer): Cover JPG quality
- `cover_save_format` (optional, string): Cover save format (extension)
- `options_show_adddate` (optional, boolean): Show add date
- `options_disable_similar` (optional, boolean): Disable similar entries
- `options_author_entries_search` (optional, boolean): Search entries by author (user)
- `options_entry_ontop` (optional, boolean): Entries pinned to top
- `options_entry_ontop_in_category` (optional, boolean): Entries pinned to top in category
- `options_other_categories` (optional, boolean): Allow an entry to belong to multiple categories (control-panel option; enables comma-separated `category` on POST/PUT)
- `options_hide_other_categories` (optional, boolean): Hide other categories

### `GET` `/blog/setup` — Get blog module settings

Returns all current blog module settings

### `PUT` `/blog/setup` — Update blog module settings

Updates blog module settings. Supports partial updates — only sent parameters are updated; others stay unchanged. The PUT response matches GET and contains the full current settings.

**Request body** (`application/json`):
- `name` (optional, string): Module name
- `categories_columns` (optional, integer): Category column count
- `categories_show_numbers` (optional, boolean): Show category numbers
- `categories_show_global_description` (optional, boolean): Show global category description
- `categories_show_category_description` (optional, boolean): Show category descriptions
- `entries_per_page` (optional, integer): Entries per page
- `entries_per_group` (optional, integer): Entries per group
- `entries_per_category` (optional, integer): Entries per category
- `entries_per_top` (optional, integer): Entries in top block
- `entries_per_rss` (optional, integer): Entries in RSS
- `switch` (optional, integer): Display toggle
- `comments_enabled` (optional, boolean): Comments enabled
- `comments_per_page` (optional, integer): Comments per page
- `comments_top_first` (optional, boolean): Show comments at top
- `sorting_main` (optional, integer): Home page sort order
- `sorting_section` (optional, integer): Section sort order
- `sorting_category` (optional, integer): Category sort order
- `sorting_user_entries` (optional, integer): User entries sort order
- `email_new_entry` (optional, boolean): Email notifications for new entries
- `email_new_comment` (optional, boolean): Email notifications for new comments
- `rating` (optional, boolean): Rating enabled
- `yablogs_off` (optional, boolean): Disable Yandex.Blogs
- `fields` (optional, array): Entry field settings
- `entry_split_enabled` (optional, boolean): Entry split enabled
- `entry_split_symbols` (optional, integer): Split character count
- `http_prefix_4` (optional, boolean): http:// prefix for field 4
- `http_prefix_5` (optional, boolean): http:// prefix for field 5
- `http_prefix_6` (optional, boolean): http:// prefix for field 6
- `http_prefix_7` (optional, boolean): http:// prefix for field 7
- `http_prefix_8` (optional, boolean): http:// prefix for field 8
- `images_max_count` (optional, integer): Maximum image count
- `images_thumb_width` (optional, integer): Thumbnail width
- `images_thumb_height` (optional, integer): Thumbnail height
- `images_full_width` (optional, integer): Full image width
- `images_full_height` (optional, integer): Full image height
- `images_max_size_kb` (optional, integer): Maximum image size in KB
- `images_jpg_quality` (optional, integer): JPG quality
- `images_loading_type` (optional, string enum['eager', 'lazy']): Image loading type
- `cover_enabled` (optional, boolean): Entry cover field enabled
- `cover_required` (optional, boolean): Cover required
- `cover_thumb_width` (optional, integer): Cover thumbnail width
- `cover_thumb_height` (optional, integer): Cover thumbnail height
- `cover_full_width` (optional, integer): Cover full image width
- `cover_full_height` (optional, integer): Cover full image height
- `cover_max_size_kb` (optional, integer): Maximum cover file size in KB
- `cover_quality` (optional, integer): Cover JPG quality
- `cover_save_format` (optional, string): Cover save format (extension)
- `options_show_adddate` (optional, boolean): Show add date
- `options_disable_similar` (optional, boolean): Disable similar entries
- `options_author_entries_search` (optional, boolean): Search entries by author (user)
- `options_entry_ontop` (optional, boolean): Entries pinned to top
- `options_entry_ontop_in_category` (optional, boolean): Entries pinned to top in category
- `options_other_categories` (optional, boolean): Allow an entry to belong to multiple categories (control-panel option; enables comma-separated `category` on POST/PUT)
- `options_hide_other_categories` (optional, boolean): Hide other categories

### `GET` `/board/setup` — Get classifieds board module settings

Returns all current classifieds board module settings

### `PUT` `/board/setup` — Update classifieds board module settings

Updates classifieds board module settings. Supports partial updates — only sent parameters are updated; others stay unchanged. The PUT response matches GET and contains the full current settings.

**Request body** (`application/json`):
- `name` (optional, string): Module name
- `categories_columns` (optional, integer): Category column count
- `categories_show_numbers` (optional, boolean): Show category numbers
- `categories_show_global_description` (optional, boolean): Show global category description
- `categories_show_category_description` (optional, boolean): Show category descriptions
- `entries_per_main` (optional, integer): Listings on home page
- `entries_per_group` (optional, integer): Listings per group
- `entries_per_category` (optional, integer): Listings per category
- `entries_per_top` (optional, integer): Listings in top block
- `entries_per_rss` (optional, integer): Listings in RSS
- `comments_enabled` (optional, boolean): Comments enabled
- `comments_per_page` (optional, integer): Comments per page
- `comments_top_first` (optional, boolean): Show comments at top
- `sorting_main` (optional, integer): Home page sort order
- `sorting_section` (optional, integer): Section sort order
- `sorting_category` (optional, integer): Category sort order
- `sorting_user_entries` (optional, integer): User listings sort order
- `sorting_menu_enabled` (optional, boolean): Show sort menu
- `sorting_menu_items` (optional, array): Sort types available in the menu (ids 0–14)
- `email_new_entry` (optional, boolean): Email notifications for new listings
- `email_new_comment` (optional, boolean): Email notifications for new comments
- `rating` (optional, boolean): Rating enabled
- `briefmax` (optional, integer): Maximum listing brief length
- `fields` (optional, array): Listing field settings (only sent items are updated by `code`)
- `http_prefix_9` (optional, boolean): http:// prefix for the Web-site field
- `http_prefix_12` (optional, boolean): http:// prefix for additional field 1
- `http_prefix_13` (optional, boolean): http:// prefix for additional field 2
- `http_prefix_14` (optional, boolean): http:// prefix for additional field 3
- `http_prefix_15` (optional, boolean): http:// prefix for additional field 4
- `http_prefix_16` (optional, boolean): http:// prefix for additional field 5
- `images_max_count` (optional, integer): Maximum image count
- `images_thumb_width` (optional, integer): Thumbnail width
- `images_thumb_height` (optional, integer): Thumbnail height
- `images_full_width` (optional, integer): Full image width
- `images_full_height` (optional, integer): Full image height
- `images_max_size_kb` (optional, integer): Maximum image size in KB
- `images_jpg_quality` (optional, integer): JPG quality
- `images_loading_type` (optional, string enum['eager', 'lazy']): Image loading type
- `images_save_format` (optional, string enum['', 'jpg', 'png', 'webp']): Image save format (`jpg`, `png`, `webp`; empty value keeps the upload format)
- `options_show_adddate` (optional, boolean): Show add date
- `options_disable_similar` (optional, boolean): Disable similar listings
- `options_author_entries_search` (optional, boolean): Search entries by author (user)
- `options_entry_ontop` (optional, boolean): Listings pinned to top
- `options_entry_ontop_in_category` (optional, boolean): Listings pinned to top in category
- `options_other_categories` (optional, boolean): Allow an entry to belong to multiple categories (control-panel option; enables comma-separated `category` on POST/PUT)
- `options_hide_other_categories` (optional, boolean): Hide other categories
- `placement_auto_deadline_mode` (optional, integer enum[0, 1, 2]): Action when listing placement expires
- `placement_limit_days` (optional, integer): Listing placement period in days
- `user_edit_enabled` (optional, boolean): Allow users to edit their listings
- `user_edit_limit_days` (optional, integer): Days after publication when a listing can still be edited
- `user_edit_interval_days` (optional, integer): Minimum hours between listing edits
- `search_fields` (optional, array): Search fields (array of field codes)
- `neighbors_sort_type` (optional, integer enum[1, 2]): Adjacent listings sort (1 — by add date, 2 — by id)
- `files_max_size_kb` (optional, integer): Maximum attachment size in KB
- `screenshot_max_size_kb` (optional, integer): Maximum screenshot size in KB
- `use_extrafields` (optional, boolean): Enable user extra fields
- `extrafields_count` (optional, integer): Extra field count

### `GET` `/publ/setup` — Get article catalog module settings

Returns all current article catalog module settings

### `PUT` `/publ/setup` — Update article catalog module settings

Updates article catalog module settings. Supports partial updates — only sent parameters are updated; others stay unchanged. The PUT response matches GET and contains the full current settings.

**Request body** (`application/json`):
- `name` (optional, string): Module name
- `top_enabled` (optional, boolean): User top block enabled
- `top_category` (optional, integer): Top category
- `top_name` (optional, string): Top name
- `top_description` (optional, string): Top description
- `categories_columns` (optional, integer): Category column count
- `categories_show_numbers` (optional, boolean): Show category numbers
- `categories_show_global_description` (optional, boolean): Show global category description
- `categories_show_category_description` (optional, boolean): Show category descriptions
- `entries_per_main` (optional, integer): Articles on home page
- `entries_per_group` (optional, integer): Articles per group
- `entries_per_category` (optional, integer): Articles per category
- `entries_per_top` (optional, integer): Articles in top block
- `entries_per_rss` (optional, integer): Articles in RSS
- `comments_enabled` (optional, boolean): Comments enabled
- `comments_per_page` (optional, integer): Comments per page
- `comments_top_first` (optional, boolean): Show comments at top
- `sorting_main` (optional, integer): Home page sort order
- `sorting_section` (optional, integer): Section sort order
- `sorting_category` (optional, integer): Category sort order
- `sorting_user_entries` (optional, integer): User articles sort order
- `sorting_menu_enabled` (optional, boolean): Show sort menu
- `sorting_menu_items` (optional, array): Sort types available in the menu (ids 0–12)
- `email_new_entry` (optional, boolean): Email notifications for new articles
- `email_new_comment` (optional, boolean): Email notifications for new comments
- `rating` (optional, boolean): Rating enabled
- `briefmax` (optional, integer): Maximum article brief length
- `fields` (optional, array): Article field settings (only sent items are updated by `code`)
- `http_prefix_6` (optional, boolean): http:// prefix for the author site field
- `http_prefix_7` (optional, boolean): http:// prefix for the source link field
- `images_max_count` (optional, integer): Maximum image count
- `images_thumb_width` (optional, integer): Thumbnail width
- `images_thumb_height` (optional, integer): Thumbnail height
- `images_full_width` (optional, integer): Full image width
- `images_full_height` (optional, integer): Full image height
- `images_max_size_kb` (optional, integer): Maximum image size in KB
- `images_jpg_quality` (optional, integer): JPG quality
- `images_loading_type` (optional, string enum['eager', 'lazy']): Image loading type
- `images_save_format` (optional, string enum['', 'jpg', 'png', 'webp']): Image save format (`jpg`, `png`, `webp`; empty value keeps the upload format)
- `options_show_adddate` (optional, boolean): Show add date
- `options_disable_similar` (optional, boolean): Disable similar articles
- `options_author_entries_search` (optional, boolean): Search entries by author (user)
- `options_entry_ontop` (optional, boolean): Articles pinned to top
- `options_entry_ontop_in_category` (optional, boolean): Articles pinned to top in category
- `options_other_categories` (optional, boolean): Allow an entry to belong to multiple categories (control-panel option; enables comma-separated `category` on POST/PUT)
- `options_hide_other_categories` (optional, boolean): Hide other categories
- `search_fields` (optional, array): Search fields (array of field codes)
- `neighbors_sort_type` (optional, integer enum[1, 2]): Adjacent articles sort (1 — by add date, 2 — by id)
- `use_extrafields` (optional, boolean): Enable user extra fields
- `extrafields_count` (optional, integer): Extra field count

### `GET` `/load/setup` — Get file catalog module settings

Returns all current file catalog module settings

### `PUT` `/load/setup` — Update file catalog module settings

Updates file catalog module settings. Supports partial updates — only sent parameters are updated; others stay unchanged. The PUT response matches GET and contains the full current settings.

**Request body** (`application/json`):
- `name` (optional, string): Module name
- `top_enabled` (optional, boolean): User top block enabled
- `top_category` (optional, integer): Top category
- `top_name` (optional, string): Top name
- `top_description` (optional, string): Top description
- `categories_columns` (optional, integer): Category column count
- `categories_show_numbers` (optional, boolean): Show category numbers
- `categories_show_global_description` (optional, boolean): Show global category description
- `categories_show_category_description` (optional, boolean): Show category descriptions
- `entries_per_main` (optional, integer): Files on home page
- `entries_per_group` (optional, integer): Files per group
- `entries_per_category` (optional, integer): Files per category
- `entries_per_top` (optional, integer): Files in top block
- `entries_per_rss` (optional, integer): Files in RSS
- `comments_enabled` (optional, boolean): Comments enabled
- `comments_per_page` (optional, integer): Comments per page
- `comments_top_first` (optional, boolean): Show comments at top
- `sorting_main` (optional, integer): Home page sort order
- `sorting_section` (optional, integer): Section sort order
- `sorting_category` (optional, integer): Category sort order
- `sorting_user_entries` (optional, integer): User files sort order
- `sorting_menu_enabled` (optional, boolean): Show sort menu
- `sorting_menu_items` (optional, array): Sort types available in the menu (ids 0–14)
- `email_new_entry` (optional, boolean): Email notifications for new files
- `email_new_comment` (optional, boolean): Email notifications for new comments
- `rating` (optional, boolean): Rating enabled
- `briefmax` (optional, integer): Maximum file brief length
- `fields` (optional, array): File field settings (only sent items are updated by `code`)
- `http_prefix_10` (optional, boolean): http:// prefix for the archive link field
- `http_prefix_14` (optional, boolean): http:// prefix for the author site field
- `http_prefix_15` (optional, boolean): http:// prefix for the program link field
- `http_prefix_16` (optional, boolean): http:// prefix for the documentation link field
- `images_max_count` (optional, integer): Maximum image count
- `images_thumb_width` (optional, integer): Thumbnail width
- `images_thumb_height` (optional, integer): Thumbnail height
- `images_full_width` (optional, integer): Full image width
- `images_full_height` (optional, integer): Full image height
- `images_max_size_kb` (optional, integer): Maximum image size in KB
- `images_jpg_quality` (optional, integer): JPG quality
- `images_loading_type` (optional, string enum['eager', 'lazy']): Image loading type
- `images_save_format` (optional, string enum['', 'jpg', 'png', 'webp']): Image save format (`jpg`, `png`, `webp`; empty value keeps the upload format)
- `options_show_adddate` (optional, boolean): Show add date
- `options_disable_similar` (optional, boolean): Disable similar files
- `options_author_entries_search` (optional, boolean): Search entries by author (user)
- `options_entry_ontop` (optional, boolean): Files pinned to top
- `options_entry_ontop_in_category` (optional, boolean): Files pinned to top in category
- `options_other_categories` (optional, boolean): Allow an entry to belong to multiple categories (control-panel option; enables comma-separated `category` on POST/PUT)
- `options_hide_other_categories` (optional, boolean): Hide other categories
- `search_fields` (optional, array): Search fields (array of field codes)
- `neighbors_sort_type` (optional, integer enum[1, 2]): Adjacent files sort (1 — by add date, 2 — by id)
- `files_max_size_kb` (optional, integer): Maximum attachment size in KB
- `screenshot_max_size_kb` (optional, integer): Maximum screenshot size in KB
- `use_extrafields` (optional, boolean): Enable user extra fields
- `extrafields_count` (optional, integer): Extra field count

### `GET` `/video/setup` — Get video module settings

Returns all current video module settings

### `PUT` `/video/setup` — Update video module settings

Updates video module settings. Supports partial updates — only sent parameters are updated; others stay unchanged. The PUT response matches GET and contains the full current settings.

**Request body** (`application/json`):
- `name` (optional, string): Module name
- `youtube_api` (optional, boolean): Use YouTube API for video uploads
- `entries_per_main` (optional, integer): Videos on home page
- `entries_per_channel` (optional, integer): Videos per channel page
- `entries_per_category` (optional, integer): Videos per category
- `entries_per_top` (optional, integer): Videos in top block
- `entries_per_rss` (optional, integer): Videos in RSS
- `entries_entry_columns` (optional, integer): Video list column count
- `entries_channel_columns` (optional, integer): Channel list column count
- `show_category_description` (optional, boolean): Show category description
- `open_in_window` (optional, boolean): Open video in a separate window
- `rating` (optional, boolean): Rating enabled
- `comments_enabled` (optional, boolean): Comments enabled
- `comments_per_page` (optional, integer): Comments per page
- `comments_top_first` (optional, boolean): Show comments at top
- `email_new_entry` (optional, boolean): Email notifications for new videos
- `email_new_comment` (optional, boolean): Email notifications for new comments
- `sorting_main` (optional, integer): Home page sort order
- `sorting_category` (optional, integer): Category sort order
- `sorting_channels` (optional, integer): Channel list sort order
- `sorting_channel_entry` (optional, integer): Videos inside channel sort order
- `sorting_menu_enabled` (optional, boolean): Show sort menu
- `sorting_menu_category_items` (optional, array): Sort types in the menu for categories and home (ids 0–25)
- `sorting_menu_channel_items` (optional, array): Sort types in the menu for channels (ids 0–8)
- `fields` (optional, array): Video field settings (only sent items are updated by `code`)
- `briefmax` (optional, integer): Maximum video brief length
- `rss_no_multi_categories` (optional, boolean): Exclude multi-category videos from RSS
- `images_max_count` (optional, integer): Maximum image (screenshot) count
- `images_preview_width` (optional, integer): Video preview width
- `images_preview_height` (optional, integer): Video preview height
- `images_thumb_width` (optional, integer): Thumbnail width
- `images_thumb_height` (optional, integer): Thumbnail height
- `images_full_width` (optional, integer): Full image width
- `images_full_height` (optional, integer): Full image height
- `images_max_size_kb` (optional, integer): Maximum image size in KB
- `images_jpg_quality` (optional, integer): JPG quality
- `images_uploader_type` (optional, integer): Image uploader type
- `images_save_format` (optional, string enum['', 'jpg', 'png', 'webp']): Image save format (`jpg`, `png`, `webp`; empty value keeps the upload format)
- `use_extrafields` (optional, boolean): Enable user extra fields
- `extrafields_count` (optional, integer): Extra field count
- `search_fields` (optional, array): Search fields (array of field codes)
- `options_entry_custom_meta` (optional, boolean): Per-entry custom HTML title (TITLE) and meta description
- `options_search_in_categories` (optional, boolean): Search within categories
- `options_author_entries_search` (optional, boolean): Search entries by author (user)

### `GET` `/photo/setup` — Get photo album module settings

Returns all current photo album module settings

### `PUT` `/photo/setup` — Update photo album module settings

Updates photo album module settings. Supports partial updates — only sent parameters are updated; others stay unchanged. The PUT response matches GET and contains the full current settings.

**Request body** (`application/json`):
- `name` (optional, string): Module name
- `categories_columns` (optional, integer): Category column count
- `categories_show_numbers` (optional, boolean): Show category numbers
- `categories_show_global_description` (optional, boolean): Show global category description
- `categories_show_category_description` (optional, boolean): Show category descriptions
- `entries_columns` (optional, integer): Album list column count (-1 — automatic)
- `entries_per_main` (optional, integer): Albums on home page
- `entries_per_group` (optional, integer): Albums per group
- `entries_per_album` (optional, integer): Photos per album page
- `entries_per_top` (optional, integer): Albums in top block
- `entries_per_rss` (optional, integer): Albums in RSS
- `comments_enabled` (optional, boolean): Comments enabled
- `comments_per_page` (optional, integer): Comments per page
- `comments_top_first` (optional, boolean): Show comments at top
- `sorting_main` (optional, integer): Home page sort order
- `sorting_section` (optional, integer): Section sort order
- `sorting_category` (optional, integer): Category sort order
- `sorting_user_entries` (optional, integer): User albums sort order
- `sorting_menu_enabled` (optional, boolean): Show sort menu
- `sorting_menu_items` (optional, array): Sort types available in the menu (ids 0–13)
- `email_new_entry` (optional, boolean): Email notifications for new albums
- `email_new_comment` (optional, boolean): Email notifications for new comments
- `rating` (optional, boolean): Rating enabled
- `briefmax` (optional, integer): Maximum album brief length
- `lightbox_enabled` (optional, boolean): Enable photo lightbox
- `lightbox_type` (optional, integer): Lightbox type
- `lightbox_entry` (optional, boolean): Show lightbox on entry page
- `multi_upload_max_count` (optional, integer): Maximum files in multi-upload
- `fields` (optional, array): Photo album field settings (only sent items are updated by `code`)
- `images_thumb_width` (optional, integer): Thumbnail width
- `images_thumb_height` (optional, integer): Thumbnail height
- `images_thumb_type` (optional, integer): Thumbnail type
- `images_thumb_count` (optional, integer): Thumbnails per row on album page
- `images_full_width` (optional, integer): Full image width
- `images_full_height` (optional, integer): Full image height
- `images_original_width` (optional, integer): Maximum original width
- `images_original_height` (optional, integer): Maximum original height
- `images_max_size_kb` (optional, integer): Maximum image size in KB
- `images_jpg_quality` (optional, integer): JPG quality
- `images_keep_original` (optional, boolean): Keep uploaded image original
- `images_loading_type` (optional, string enum['eager', 'lazy']): Image loading type
- `images_save_format` (optional, string enum['', 'jpg', 'png', 'webp']): Image save format (`jpg`, `png`, `webp`; empty value keeps the upload format)
- `options_show_adddate` (optional, boolean): Show add date
- `options_disable_similar` (optional, boolean): Disable similar albums
- `options_author_entries_search` (optional, boolean): Search entries by author (user)
- `search_fields` (optional, array): Search fields (array of field codes)
- `use_extrafields` (optional, boolean): Enable user extra fields
- `extrafields_count` (optional, integer): Extra field count

### `GET` `/faq/setup` — Get FAQ module settings

Returns all current FAQ (Q&A) module settings

### `PUT` `/faq/setup` — Update FAQ module settings

Updates FAQ module settings. Supports partial updates — only sent parameters are updated; others stay unchanged. The PUT response matches GET and contains the full current settings.

**Request body** (`application/json`):
- `name` (optional, string): Module name
- `categories_columns` (optional, integer): Category column count
- `categories_show_numbers` (optional, boolean): Show category numbers
- `categories_show_category_description` (optional, boolean): Show category descriptions
- `categories_show_in_category_list` (optional, boolean): Show questions in category list
- `entries_per_page` (optional, integer): Questions per page
- `anchor_enabled` (optional, boolean): Enable anchor links to questions
- `anchor_show_numbers` (optional, boolean): Show numbers in anchor links
- `rating` (optional, boolean): Rating enabled
- `email_admin` (optional, boolean): Email notifications to admin for new questions
- `fields` (optional, array): FAQ field settings (only sent items are updated by `code`)
- `images_max_count` (optional, integer): Maximum image count
- `images_thumb_width` (optional, integer): Thumbnail width
- `images_thumb_height` (optional, integer): Thumbnail height
- `images_full_width` (optional, integer): Full image width
- `images_full_height` (optional, integer): Full image height
- `images_max_size_kb` (optional, integer): Maximum image size in KB
- `images_jpg_quality` (optional, integer): JPG quality
- `images_loading_type` (optional, string enum['eager', 'lazy']): Image loading type
- `images_save_format` (optional, string enum['', 'jpg', 'png', 'webp']): Image save format (`jpg`, `png`, `webp`; empty value keeps the upload format)
- `images_uploader_type` (optional, integer): Image uploader type
- `images_group_preview_enabled` (optional, boolean): Group image preview in entry list
- `search_fields` (optional, array): Search fields (array of field codes)

### `GET` `/gb/setup` — Get guestbook module settings

Returns all current guestbook module settings

### `PUT` `/gb/setup` — Update guestbook module settings

Updates guestbook module settings. Supports partial updates — only sent parameters are updated; others stay unchanged. The PUT response matches GET and contains the full current settings.

**Request body** (`application/json`):
- `name` (optional, string): Module name
- `new_on_top` (optional, boolean): New entries at top
- `add_page` (optional, boolean): Separate add-entry page
- `form_top` (optional, boolean): Add form above the list
- `posts_per_page` (optional, integer): Entries per page
- `post_max_length` (optional, integer): Maximum entry text length
- `max_posts` (optional, integer): Maximum guestbook entry count
- `rating` (optional, boolean): Entry rating enabled
- `email_admin` (optional, boolean): Email notifications to admin for new entries
- `fields` (optional, array): Optional form field settings (only sent items are updated by `code`)
- `stop_words` (optional, array): Stop words for entry filtering (replaces the full list)

### `GET` `/dir/setup` — Get site catalog module settings

Returns all current site catalog module settings.

### `PUT` `/dir/setup` — Update site catalog module settings

Updates site catalog module settings. Supports partial updates — only sent parameters are updated; others stay unchanged. The PUT response matches GET and contains the full current settings.

**Request body** (`application/json`):
- `name` (optional, string): Module name
- `top_enabled` (optional, boolean): User top block enabled
- `top_category` (optional, integer): Top category
- `top_name` (optional, string): Top block name
- `top_description` (optional, string): Top block description
- `categories_columns` (optional, integer): Number of category columns
- `categories_show_numbers` (optional, boolean): Show category numbers
- `categories_show_global_description` (optional, boolean): Show global category description
- `categories_show_category_description` (optional, boolean): Show individual category description
- `entries_per_main` (optional, integer): Entries on main page
- `entries_per_group` (optional, integer): Entries per group
- `entries_per_category` (optional, integer): Entries per category
- `entries_per_top` (optional, integer): Entries in top block
- `entries_per_rss` (optional, integer): Entries in RSS feed
- `comments_enabled` (optional, boolean): Comments enabled
- `comments_per_page` (optional, integer): Comments per page
- `comments_top_first` (optional, boolean): Show newest comments first
- `sorting_main` (optional, integer): Main page sorting
- `sorting_section` (optional, integer): Section sorting
- `sorting_category` (optional, integer): Category sorting
- `sorting_user_entries` (optional, integer): User entries sorting
- `sorting_menu_enabled` (optional, boolean): Show sorting menu
- `sorting_menu_items` (optional, array): Sorting types available in the menu (identifiers 0–16)
- `email_new_entry` (optional, boolean): Email notifications for new entries
- `email_new_comment` (optional, boolean): Email notifications for new comments
- `rating` (optional, boolean): Rating enabled
- `briefmax` (optional, integer): Maximum brief description length
- `fields` (optional, array): Entry field settings (only submitted items are updated, matched by `code`)
- `http_prefix_2` (optional, boolean): http:// prefix for the "Site URL" field
- `http_prefix_9` (optional, boolean): http:// prefix for the "Link 2" field
- `http_prefix_10` (optional, boolean): http:// prefix for custom field 1
- `http_prefix_11` (optional, boolean): http:// prefix for custom field 2
- `http_prefix_12` (optional, boolean): http:// prefix for custom field 3
- `http_prefix_13` (optional, boolean): http:// prefix for custom field 4
- `http_prefix_14` (optional, boolean): http:// prefix for custom field 5
- `images_max_count` (optional, integer): Maximum number of images
- `images_thumb_width` (optional, integer): Thumbnail width
- `images_thumb_height` (optional, integer): Thumbnail height
- `images_full_width` (optional, integer): Full image width
- `images_full_height` (optional, integer): Full image height
- `images_max_size_kb` (optional, integer): Maximum image size in KB
- `images_jpg_quality` (optional, integer): JPG quality
- `images_loading_type` (optional, string enum['eager', 'lazy']): Image loading type
- `images_save_format` (optional, string enum['', 'jpg', 'png', 'webp']): Image save format (`jpg`, `png`, `webp`; empty value keeps the upload format)
- `cover_enabled` (optional, boolean): Entry cover field enabled
- `cover_required` (optional, boolean): Cover is required
- `cover_thumb_width` (optional, integer): Cover thumbnail width
- `cover_thumb_height` (optional, integer): Cover thumbnail height
- `cover_full_width` (optional, integer): Cover full image width
- `cover_full_height` (optional, integer): Cover full image height
- `cover_max_size_kb` (optional, integer): Maximum cover file size in KB
- `cover_quality` (optional, integer): Cover JPG quality
- `cover_save_format` (optional, string): Cover save format (file extension)
- `options_show_adddate` (optional, boolean): Show date added
- `options_disable_similar` (optional, boolean): Disable similar entries
- `options_author_entries_search` (optional, boolean): Search entries by author (user)
- `options_entry_ontop` (optional, boolean): Allow entries on top
- `options_entry_ontop_in_category` (optional, boolean): Allow entries on top in category
- `options_other_categories` (optional, boolean): Allow an entry to belong to multiple categories (control-panel option; enables comma-separated `category` on POST/PUT)
- `options_hide_other_categories` (optional, boolean): Hide from other categories
- `search_fields` (optional, array): Search fields (array of field codes)
- `neighbors_sort_type` (optional, integer enum[1, 2]): Neighboring entries sorting (1 — by date, 2 — by id)
- `files_max_size_kb` (optional, integer): Maximum attached file size in KB
- `screenshot_max_size_kb` (optional, integer): Maximum screenshot size in KB
- `use_extrafields` (optional, boolean): Enable user extra fields
- `extrafields_count` (optional, integer): Extra field count

### `GET` `/stuff/setup` — Get online games module settings

Returns all current online games module settings.

### `PUT` `/stuff/setup` — Update online games module settings

Updates online games module settings. Supports partial updates — only sent parameters are updated; others stay unchanged. The PUT response matches GET and contains the full current settings.

**Request body** (`application/json`):
- `name` (optional, string): Module name
- `categories_columns` (optional, integer): Number of category columns
- `categories_show_numbers` (optional, boolean): Show category numbers
- `categories_show_global_description` (optional, boolean): Show global category description
- `categories_show_category_description` (optional, boolean): Show individual category description
- `entries_columns` (optional, integer): Number of entry columns
- `entries_per_main` (optional, integer): Entries on main page
- `entries_per_group` (optional, integer): Entries per group
- `entries_per_category` (optional, integer): Entries per category
- `entries_per_top` (optional, integer): Entries in top block
- `entries_per_rss` (optional, integer): Entries in RSS feed
- `comments_enabled` (optional, boolean): Comments enabled
- `comments_per_page` (optional, integer): Comments per page
- `comments_top_first` (optional, boolean): Show newest comments first
- `sorting_main` (optional, integer): Main page sorting
- `sorting_section` (optional, integer): Section sorting
- `sorting_category` (optional, integer): Category sorting
- `sorting_show_menu` (optional, boolean): Show sorting menu
- `sorting_menu_items` (optional, array): Sorting types available in the menu (identifiers 0–16)
- `email_notifications_on_new_entry` (optional, boolean): Email notifications for new entries
- `email_notifications_on_new_comment` (optional, boolean): Email notifications for new comments
- `rating_enabled` (optional, boolean): Rating enabled
- `brief_description_max_length` (optional, integer): Maximum brief description length
- `fields` (optional, array): Entry field settings (only submitted items are updated by `code`; `required` for `comments` is ignored)
- `http_prefix_10` (optional, boolean): http:// prefix for custom field 1
- `http_prefix_11` (optional, boolean): http:// prefix for custom field 2
- `http_prefix_13` (optional, boolean): http:// prefix for custom field 3
- `http_prefix_14` (optional, boolean): http:// prefix for custom field 4
- `http_prefix_15` (optional, boolean): http:// prefix for custom field 5
- `images_max_count` (optional, integer): Maximum number of images to upload
- `images_thumb_width` (optional, integer): Screenshot thumbnail width
- `images_thumb_height` (optional, integer): Screenshot thumbnail height
- `images_full_width` (optional, integer): Screenshot full image width
- `images_full_height` (optional, integer): Screenshot full image height
- `images_max_size_kb` (optional, integer): Maximum screenshot image size in KB
- `images_jpg_quality` (optional, integer): Screenshot JPG quality
- `images_uploader_type` (optional, integer): Image uploader type
- `images_save_format` (optional, string enum['', 'jpg', 'png', 'webp']): Screenshot save format (`jpg`, `png`, `webp`; empty — original format)
- `images_loading_type` (optional, string enum['eager', 'lazy']): Screenshot loading type
- `images_group_preview_enabled` (optional, boolean): Enable group image preview
- `options_show_adddate` (optional, boolean): Show date added
- `options_disable_similar` (optional, boolean): Disable similar entries
- `options_author_entries_search` (optional, boolean): Search entries by author (user)
- `options_entry_ontop` (optional, boolean): Allow entries on top
- `options_entry_ontop_in_category` (optional, boolean): Allow entries on top in category
- `options_other_categories` (optional, boolean): Allow an entry to belong to multiple categories (control-panel option; enables comma-separated `category` on POST/PUT)
- `options_hide_other_categories` (optional, boolean): Hide from other categories
- `cover_enabled` (optional, boolean): Entry cover field enabled
- `cover_required` (optional, boolean): Cover is required
- `cover_thumb_width` (optional, integer): Cover thumbnail width
- `cover_thumb_height` (optional, integer): Cover thumbnail height
- `cover_full_width` (optional, integer): Cover full image width
- `cover_full_height` (optional, integer): Cover full image height
- `cover_max_size_kb` (optional, integer): Maximum cover file size in KB
- `cover_quality` (optional, integer): Cover JPG quality
- `cover_save_format` (optional, string): Cover save format (file extension)
- `search_fields` (optional, array): Search fields (array of field codes)
- `neighbors_sort_type` (optional, integer enum[1, 2]): Neighboring entries sorting (1 — by date, 2 — by id)
- `files_max_size_kb` (optional, integer): Maximum attached file size in KB
- `screenshot_max_size_kb` (optional, integer): Maximum screenshot size in KB
- `use_extrafields` (optional, boolean): Enable user extra fields
- `extrafields_count` (optional, integer): Extra field count

### `GET` `/forum/setup` — Get forum module settings

Returns all current forum module settings.

### `PUT` `/forum/setup` — Update forum module settings

Updates forum module settings. Supports partial updates — only sent parameters are updated; others stay unchanged. The PUT response matches GET and contains the full current settings.

**Request body** (`application/json`):
- `name` (optional, string): Module name
- `top_enabled` (optional, boolean): User top block enabled
- `top_category` (optional, integer): Top category
- `top_name` (optional, string): Top block name
- `top_description` (optional, string): Top block description
- `page_title` (optional, boolean): Show forum name in the page title
- `post_form` (optional, boolean): Show quick reply form below a thread
- `ajax_edit` (optional, boolean): Allow editing messages without page reload
- `buttons_group` (optional, integer): Editor button group identifier
- `buttons_group_own` (optional, string): URL of a custom editor button set (max 150 characters)
- `icons_group` (optional, integer): Thread icon group identifier
- `icons_group_own` (optional, string): URL of a custom thread icon set (max 150 characters)
- `icons_group1` (optional, string): URL of an additional icon set (max 150 characters)
- `status` (optional, boolean): Show user status in the forum
- `legends` (optional, boolean): Show forum icon legend
- `show_views` (optional, boolean): Show the Views column in the thread list
- `show_user_rights` (optional, boolean): Show the block describing user permissions on the forum
- `recent_posts_period_days` (optional, integer enum[1, 7, 30]): Time window for messages on the Recent posts page (in days)
- `online_include_site_users` (optional, boolean): Include all site visitors in Who is online
- `admin_email_on_new_post` (optional, boolean): Email the administrator when a new post is added
- `wiki_post_enabled` (optional, boolean): Use a wiki-style first post for threads with attached messages
- `hide_subforum_topics` (optional, boolean): Hide subforum threads in the parent forum thread list
- `threads_per_page` (optional, integer): Threads per section page
- `threads_hot_threshold` (optional, integer): Hot thread threshold — minimum number of replies
- `posts_per_page` (optional, integer): Posts per thread page
- `posts_max_length` (optional, integer): Maximum post length in characters
- `min_messages_to_create_thread` (optional, integer): Number of messages a user must have posted before creating a new thread
- `rss_entries` (optional, integer): Number of entries in the forum RSS feed
- `edit_time_threads_days` (optional, integer): Days users can edit threads (0 — no limit)
- `edit_time_messages_days` (optional, integer): Days users can edit messages (0 — no limit)
- `report_enabled` (optional, boolean): Allow users to report messages
- `subscribe_enabled` (optional, boolean): Allow subscriptions to threads and forum sections
- `subscribe_type` (optional, integer enum[1, 2]): Subscription type (1 — instant, 2 — daily digest)
- `images_thumb_width` (optional, integer): Attached image thumbnail width
- `images_thumb_height` (optional, integer): Attached image thumbnail height
- `images_full_width` (optional, integer): Attached image full width
- `images_full_height` (optional, integer): Attached image full height
- `images_jpg_quality` (optional, integer): Attached image JPG quality
- `images_loading_type` (optional, string enum['eager', 'lazy']): Image loading type
- `images_save_format` (optional, string enum['', 'jpg', 'png', 'webp']): Image save format (`jpg`, `png`, `webp`; empty value keeps the upload format)
- `max_attachments_count` (optional, integer): Maximum attachments per message
- `upload_max_size_kb` (optional, integer): Maximum attachment size in KB
- `reset_visitor_record` (optional, boolean): Reset the forum visitor record (one-shot action when `visitor_record.can_reset` is `true` in the GET response)

### `GET` `/tests/setup` — Get tests module settings

Returns all current tests module settings.

### `PUT` `/tests/setup` — Update tests module settings

Updates tests module settings. Supports partial updates: only supplied parameters are updated, while the remaining settings stay unchanged. The PUT response matches GET and contains the complete current settings.

**Request body** (`application/json`):
- `name` (optional, string): Module name
- `categories_columns` (optional, integer): Number of category columns
- `categories_show_numbers` (optional, boolean): Show category numbers
- `categories_show_description` (optional, boolean): Show category descriptions
- `categories_show_categories` (optional, boolean): Show categories
- `entries_per_page` (optional, integer): Number of tests per page

### `GET` `/mchat/setup` — Get mini-chat settings

Returns all current mini-chat settings.

### `PUT` `/mchat/setup` — Update mini-chat settings

Updates mini-chat settings. Supports partial updates: only supplied parameters are updated, while the remaining settings stay unchanged. The PUT response matches GET and contains the complete current settings.

**Request body** (`application/json`):
- `new_on_top` (optional, boolean): Show new messages at the top
- `email_admin` (optional, boolean): Send new message notifications to the administrator
- `user_secure` (optional, boolean): Require user confirmation when sending a message
- `message_length` (optional, integer): Maximum message length
- `max_posts` (optional, integer): Maximum number of messages; the upper limit depends on the site limit
- `split_words` (optional, integer): Minimum word length at which a word is wrapped
- `fields` (optional, array): Message form fields
- `replace_words` (optional, object): Word replacements in messages

### `GET` `/polls/setup` — Get polls module settings

Returns all current polls module settings.

### `PUT` `/polls/setup` — Update polls module settings

Updates polls module settings. Supports partial updates: only supplied parameters are updated, while the remaining settings stay unchanged. The PUT response matches GET and contains the complete current settings.

**Request body** (`application/json`):
- `timeout` (optional, integer): Retention period for the poll participation mark
- `timeout_per` (optional, integer enum[0, 1]): Retention period unit: 0 — days, 1 — minutes
- `send_email` (optional, boolean): Send email notifications
- `arch_all` (optional, boolean): Show all polls, including archived polls

### `GET` `/search/setup` — Get site search settings

Returns all current site search settings.

### `PUT` `/search/setup` — Update site search settings

Updates site search settings. Supports partial updates: only supplied parameters are updated, while the remaining settings stay unchanged. The PUT response matches GET and contains the complete current settings.

**Request body** (`application/json`):
- `entries_per_page` (optional, integer): Number of search results per page
- `total_entries` (optional, integer): Maximum number of search results
- `description_length` (optional, integer): Length of the result description excerpt
- `modules_search` (optional, array): Modules included in search
- `modules_menu` (optional, array): Modules displayed in the search menu
- `tags_by_default` (optional, boolean): Search by tags by default
- `tags_app` (optional, boolean): Use tag search
- `tags_sort_order` (optional, integer enum[0, 1]): Tag sorting order
- `related_sorting_disabled` (optional, boolean): Disable sorting of related materials

### `GET` `/seo/setup` — Get SEO module settings

Returns the global SEO module settings for the site. All settings are returned as boolean values. The seo_EnableGuestBookIndex setting controls the search-engine indexing restriction for the Guestbook.

### `PUT` `/seo/setup` — Update SEO module settings

Partially updates the global SEO module settings. Submitted fields are saved; omitted fields remain unchanged. All fields must be JSON booleans or integer 0/1 values. seo_EnableGuestBookIndex can be disabled only when premoderation is enabled for the Guests group. Otherwise the API returns SEO_GUESTBOOK_INDEXING_CONFLICT with HTTP 409.

**Request body** (`application/json`):
- `seo_UseUniqTitleDescKeys` (optional, boolean)
- `seo_ChpuUrlType` (optional, boolean)
- `seo_DisableIndexing` (optional, boolean)
- `seo_UseRelCanonical` (optional, boolean)
- `seo_DisablePageNavi301` (optional, boolean)
- `seo_EnableDisableRobotxTxt` (optional, boolean)
- `seo_EnableGuestBookIndex` (optional, boolean)

### `GET` `/site/setup` — Get main site settings

Returns the current main site settings

### `PUT` `/site/setup` — Update main site settings

Updates main site settings. Supports partial updates — only sent parameters are updated; others stay unchanged. The request body is flat: field names match GET paths with nesting replaced by underscores (for example, `watermark.enabled` → `watermark_enabled`). The PUT response matches GET and contains the full current settings. If captcha type reCAPTCHA (6 or 7) is selected without both keys, the whole request is rejected with HTTP 406 and nothing is saved (including other fields in the same PUT). Your own site key and secret key are required for both system zones and custom domains. Boolean values in PUT: `true` / `1` / `yes` (case-insensitive) are treated as true; otherwise as false.

**Request body** (`application/json`):
- `site_name` (optional, string): Site name
- `site_link` (optional, string): Site link (system host or bound domain only; otherwise `/`)
- `formats_date` (optional, string): Date format. Only tokens `$yyyy$`, `$yy$`, `$MOD$`, `$MO$`, `$Mo$`, `$mo$`, `$dd$` and separators `. , : / space -` are allowed; otherwise `$yyyy$-$mo$-$dd$` is stored.
- `formats_time` (optional, string): Time format. Only tokens `$HH$`, `$hh$`, `$AP$`, `$mm$`, `$ss$` and separators `. , : / space -` are allowed; otherwise `$hh$:$mm$ $AP$` is stored.
- `formats_week` (optional, string): Weekday format. Only tokens `$WD$`, `$wd$` and separators `. , : / space -` are allowed; otherwise `$WD$` is stored.
- `show_today` (optional, boolean): Show current date and time
- `timezone_offset` (optional, integer): Site timezone offset from UTC (hours)
- `watermark_enabled` (optional, boolean): Whether the watermark is enabled
- `watermark_type` (optional, integer enum[0, 1, 2]): Watermark type (0 — legacy text, 1 — new text, 2 — image). Value 2 is forced to 0 when banner upload is unavailable on the site.
- `watermark_text` (optional, string): Watermark text (max 35 characters; ASCII-only for type 0)
- `watermark_font` (optional, string): Display name of the watermark font (as shown in the control panel, e.g. `Arial Narrow`). An unknown name falls back to DejaVu Sans.
- `watermark_size` (optional, integer): Watermark font size
- `watermark_text_color` (optional, string): Watermark text color as `#RRGGBB`
- `watermark_outline_enabled` (optional, boolean): Whether watermark text outline is enabled
- `watermark_outline_color` (optional, string): Watermark outline color as `#RRGGBB`
- `watermark_image_path` (optional, string): Path to the watermark PNG image (max 200×200)
- `watermark_transparency` (optional, integer): Watermark transparency (0–100; out-of-range values are clamped to 0 or 90)
- `watermark_position` (optional, string enum['tl', 'tr', 'bl', 'br', 'c']): Watermark position (`tl` / `tr` / `bl` / `br` / `c`; other → `br`)
- `watermark_quality` (optional, integer): Watermark JPEG quality (default 80)
- `editor_type` (optional, integer): Editor type (allowed values come from the control panel editor list)
- `editor_generation` (optional, integer enum[0, 1, 255]): Editor generation (`0`, `1`, or `255`). For editor types other than 1, values `255` and `0` are forced to `1`.
- `editor_theme` (optional, integer): CKEditor theme
- `editor_jodit_theme` (optional, integer): Jodit theme
- `editor_use_br` (optional, boolean): Enter inserts `<br>` instead of a `<p>` paragraph
- `smiles_group` (optional, integer): Smiles group id
- `redirect_module` (optional, string): Homepage redirect module. Both `news` and `/news` are accepted (GET always returns canonical `/news`). Empty value, `0`, or an unknown module is stored as an empty string.
- `lightbox_version` (optional, integer enum[0, 1, 2]): Lightbox version
- `jquery_version` (optional, integer enum[3, 5]): jQuery version (`3` or `5`)
- `images_max_count` (optional, integer): Maximum number of images (minimum 1, default 5)
- `images_thumb_width` (optional, integer): Thumbnail width (minimum 50, default 500)
- `images_thumb_height` (optional, integer): Thumbnail height (minimum 50, default 500)
- `images_full_width` (optional, integer): Full image width (capped by plan limits)
- `images_full_height` (optional, integer): Full image height (capped by plan limits)
- `images_max_size_kb` (optional, integer): Maximum image size in KB
- `images_jpg_quality` (optional, integer): JPG quality (0–100, default 90)
- `images_loading_type` (optional, string enum['eager', 'lazy']): Image loading type
- `images_save_format` (optional, string enum['', 'jpg', 'png', 'webp']): Image save format (`jpg`, `png`, `webp`; empty keeps the upload format)
- `images_uploader_type` (optional, integer enum[0, 1]): Image uploader type
- `images_group_preview_enabled` (optional, boolean): Group image preview in entry lists
- `classification_hide_poll` (optional, boolean): Hide the classification poll. Applied only for a pro site or a site with a linked phone number, and only when RTB category, adult, and warez are all set; otherwise `false` is stored.
- `classification_rtb_category_id` (optional, integer): RTB category id from the ads category catalog. An unknown id or reserved value `18` is reset to `0`.
- `classification_adult_enabled` (optional, boolean): Site contains adult content
- `classification_adult_other` (optional, boolean): Adult subtype “other” (meaningful only when `classification_adult_enabled` is true)
- `classification_adult_ero` (optional, boolean): Adult subtype “erotica” (meaningful only when `classification_adult_enabled` is true)
- `classification_adult_porn` (optional, boolean): Adult subtype “porn” (meaningful only when `classification_adult_enabled` is true). If adult is enabled but none of the three subtypes is set, “other” is stored.
- `classification_warez_enabled` (optional, boolean): Site contains warez content
- `captcha_type` (optional, integer enum[0, 1, 2, 4, 6, 7, 8]): Captcha type (`0`, `1`, `2`, `4`, `6`, `7`, `8`; other → `4`). Types `6` and `7` are reCAPTCHA v2/v3. Your own site key and secret key are required for both system zones and custom domains. Without both keys the request is rejected with HTTP 406.
- `captcha_cleantalk_access_key` (optional, string): CleanTalk access key (truncated to 45 characters)
- `captcha_recaptcha_site_key` (optional, string): reCAPTCHA site key (truncated to 45 characters)
- `captcha_recaptcha_secret_key` (optional, string): reCAPTCHA secret key (truncated to 45 characters)
- `captcha_recaptcha_theme` (optional, integer): reCAPTCHA widget theme
- `moderation_panel_design_type` (optional, integer): Moderation panel design type (`0`–`3`). Value `4` is allowed only for sites created before 2015-04-27; otherwise it is reset to `0`.
- `moderation_panel_buttons_type` (optional, integer enum[0, 1]): Moderation panel buttons type
- `accessibility_enabled` (optional, boolean): Whether the accessibility widget is enabled
- `accessibility_vertical_position` (optional, integer enum[0, 1]): Widget button vertical position
- `accessibility_button_orientation` (optional, string enum['horizontal', 'vertical']): Widget button orientation
- `accessibility_button_background` (optional, string): Button background color (`#RGB` or `#RRGGBB`; otherwise `#000`)
- `accessibility_button_text_color` (optional, string): Button text color (`#RGB` or `#RRGGBB`; otherwise `#fff`)
- `accessibility_fixed` (optional, boolean): Fixed widget position
- `accessibility_onload` (optional, boolean): Enable accessibility mode on page load
- `accessibility_hide_images` (optional, boolean): Hide images in accessibility mode
- `accessibility_light_background` (optional, boolean): Light background in accessibility mode
- `accessibility_font_sizes` (optional, array): Widget font sizes. Only values from the set `18`, `20`, `22`, `24`, `26`, `28` are kept; an empty result is replaced with the full set.
- `accessibility_position` (optional, integer): Widget position on the page (`0`–`2`)
- `language_site` (optional, string): Site language (code from the site language list; unknown → `en`)
- `language_panel` (optional, string): Control panel language (code from the panel language list; unknown → `en`)
- `availability_closed` (optional, boolean): Site is closed to visitors
- `availability_closed_message` (optional, string): Message shown when the site is closed (if closed and empty, the default panel text is used)
- `online_counter_enabled` (optional, boolean): Whether the online users counter is enabled
- `online_counter_max_users` (optional, integer): Maximum users in the counter (`5`–`50`, default `5`)
- `proxy_shorten_external_links` (optional, boolean): Shorten external links. Mutually exclusive with `proxy_proxy_external_links`: if both flags are sent, shortening wins.
- `proxy_proxy_external_links` (optional, boolean): Proxy external links (mutually exclusive with shortening)
- `domain_redirect_301` (optional, boolean): 301 redirect to the primary domain
- `domain_old_domain_indexing_allowed` (optional, boolean): Allow indexing of the old domain (file side effect only when a domain is bound)
- `domain_www_primary` (optional, boolean): Treat `www` as the primary domain variant. For sites registered after the panel cutoff, GET returns `null` and PUT is ignored.
- `cookie_policy_enabled` (optional, boolean): Show the cookie notice. When `false`, cookie policy settings are removed entirely. Enabling them again creates the block.
- `cookie_policy_message` (optional, string): Cookie notice text
- `cookie_policy_button_label` (optional, string): Consent button label
- `cookie_policy_position` (optional, integer): Notice position (`0`–`2`; out of range → `0`)
- `top_enabled` (optional, boolean): Participate in the Top Sites catalog. If participation is locked by platform administration, PUT for `top_*` fields is ignored.
- `top_category` (optional, integer): Top Sites catalog category (id from the top categories list)
- `top_description` (optional, string): Short site description for the Top Sites catalog
- `constructor_enabled` (optional, boolean): Whether the visual constructor is enabled
- `comments_tree_mode` (optional, boolean): Tree mode for comments
- `disable_ajax_pagination` (optional, boolean): Disable AJAX pagination
- `human_friendly_urls` (optional, boolean): Human-friendly URLs (ignored when locked by the SEO module)
- `doctype` (optional, string): Custom DOCTYPE (see GET description)
- `pda_enabled` (optional, boolean): Whether PDA mode is enabled (flag only)
- `uwbb_enabled` (optional, boolean): Whether the BB-codes editor is enabled
- `uwbb_buttons` (optional, string): Comma-separated comment toolbar button ids. Unknown ids are dropped. An empty string is replaced with the default toolbar set.
- `uwbb_buttons_forum` (optional, string): Comma-separated forum toolbar button ids. An empty string falls back to the comments toolbar list.
- `uwbb_iconset` (optional, integer enum[0, 1, 2]): Icon set (`0` — text, `1` — color, `2` — monochrome; other → `1`)
- `uwbb_css_file` (optional, string): Path to a custom editor CSS file (letters, digits, slash, colon, period, underscore, and hyphen are allowed)
- `uwbb_smiles_enabled` (optional, boolean): Show smiles in the BB-codes editor
- `seo_meta_title` (optional, string): Homepage title (empty string clears the field)
- `seo_meta_description` (optional, string): Homepage description (empty string clears the field)
- `seo_meta_keywords` (optional, string): Homepage keywords (empty string clears the field)

---
## Security

OpenAPI: https://api.ucoz.net/security-openapi.yaml

API for site security operations: FTP password management and new site quarantine. ## Bearer Token authorization All API requests require Bearer token authorization. To use the API you need to: 1. Get a [Bearer token](/en/start.html) (access token) 2. Specify your site domain in the "Server" field below 3. Enter the token in "Authorize" (button at the bottom right) Endpoints are available only to the site owner — the API key must be created on this site in the control panel. Quarantine endpoint…

**Tags:**
- `FTP access`: Get FTP connection parameters, set, change, and reset the site FTP password
- `Quarantine`: Check quarantine status and remove restrictions from a new site

| Method | Path | Summary |
|---|---|---|
| `GET` | `/ftp_password` | FTP connection parameters |
| `POST` | `/ftp_password` | Set FTP password |
| `PUT` | `/ftp_password` | Change FTP password |
| `DELETE` | `/ftp_password` | Reset FTP password |
| `GET` | `/quarantine` | Quarantine status |
| `POST` | `/quarantine/unlock` | Remove quarantine |

### `GET` `/ftp_password` — FTP connection parameters

Returns site FTP connection parameters without the password in plain text. Available only to the site owner — the API key must be created on this site in the control panel. The `ftp_password_set` field indicates whether a password is set. The password itself is not returned via `GET` — only after a successful `POST` or `PUT`.

### `POST` `/ftp_password` — Set FTP password

Creates the site FTP password (initial setup). Available only when no password is set yet (`ftp_password_set: 0`). On success, returns full connection parameters including the password in plain text. Password: Latin letters, digits, `_` and `-` characters, 6 to 15 characters long.

**Request body** (`application/x-www-form-urlencoded / application/json`):
- `password` (required, string): New FTP password. Latin letters, digits, `_` and `-` are allowed. Length from 6 to 15 characters (same rules as in the control panel).

### `PUT` `/ftp_password` — Change FTP password

Updates the existing site FTP password. Available only when a password is already set (`ftp_password_set: 1`). On success, returns new connection parameters with the password in plain text. Password rules are the same as for `POST`.

**Request body** (`application/x-www-form-urlencoded / application/json`):
- `password` (required, string): New FTP password. Latin letters, digits, `_` and `-` are allowed. Length from 6 to 15 characters (same rules as in the control panel).

### `DELETE` `/ftp_password` — Reset FTP password

Removes the stored site FTP password. Available only when a password is set. The response contains connection parameters without the `ftp_password` field; `ftp_password_set` will be `0`.

### `GET` `/quarantine` — Quarantine status

Returns whether the site is in quarantine mode. Quarantine is a temporary restriction applied to a new site after registration. While quarantine is active, the control panel shows a corresponding notice. Available only to the site owner — the API key must be created on this site in the control panel with the "Access to control panel" permission enabled. This request is read-only and does not change site settings. Typical automation flow: check `locked`, then call `POST /quarantine/unlock` if needed.

### `POST` `/quarantine/unlock` — Remove quarantine

Removes site quarantine — the same action as confirming quarantine removal in the control panel, without interactive steps (suitable for automation). Available only to the site owner — the API key must be created on this site in the control panel with the "Access to control panel" permission enabled. A repeated call when quarantine is already removed still returns success (`unlocked: true`). Request body is optional. Setting quarantine via API (`POST /quarantine/lock`) is planned for a future version.

---
## Minichat module

OpenAPI: https://api.ucoz.net/mchat-openapi.yaml

| Method | Path | Summary |
|---|---|---|
| `GET` | `/mchat` | Get all minichat messages |
| `POST` | `/mchat` | Add message |
| `PUT` | `/mchat` | Edit message |
| `DELETE` | `/mchat` | Delete message |
| `GET` | `/mchat/smiles` | Get emoticon list |

### `GET` `/mchat` — Get all minichat messages

Get a list of all minichat messages. Messages per page depend on module settings. If the chat is empty, you receive `{"error":{"msg":"Message list is empty"}}` (not an empty array `[]`).

**Parameters:**
- `page` (query, optional, integer): Page number

### `POST` `/mchat` — Add message

Add a new message to minichat

**Request body** (`application/x-www-form-urlencoded`):
- `message` (required, string): Message text
- `email` (optional, string): Message author email (if added by a guest)
- `url` (optional, string): www field value
- `custom1` (optional, string): Additional field 1
- `custom2` (optional, string): Additional field 2

### `PUT` `/mchat` — Edit message

Edit an existing message

**Parameters:**
- `id` (query, required, integer): Message ID

**Request body** (`application/x-www-form-urlencoded`):
- `message` (required, string): Message text
- `pending` (optional, string enum[True, False]): Whether this message is pending moderation
- `email` (optional, string): Message author email (if added by a guest)
- `url` (optional, string): www field value
- `custom1` (optional, string): Additional field 1
- `custom2` (optional, string): Additional field 2

### `DELETE` `/mchat` — Delete message

Delete a message from minichat

**Parameters:**
- `id` (query, required, integer): Message ID

### `GET` `/mchat/smiles` — Get emoticon list

Get available minichat emoticons. Each array item is an object with one field: key — emoticon id, value — emoticon code.

---
## Polls Module

OpenAPI: https://api.ucoz.net/polls-openapi.yaml

| Method | Path | Summary |
|---|---|---|
| `GET` | `/polls` | Get all polls |
| `POST` | `/polls` | Add poll |
| `PUT` | `/polls` | Edit poll |
| `DELETE` | `/polls` | Delete poll |

### `GET` `/polls` — Get all polls

Get a list of all polls. Polls per page depend on module settings.

**Parameters:**
- `page` (query, optional, integer): Page number

### `POST` `/polls` — Add poll

Add a new poll

**Request body** (`application/x-www-form-urlencoded`):
- `question` (required, string): Poll question
- `answer1` (required, string): First answer option
- `answer2` (required, string): Second answer option

### `PUT` `/polls` — Edit poll

Edit existing poll

**Parameters:**
- `id` (query, required, integer): Poll ID

**Request body** (`application/x-www-form-urlencoded`):
- `question` (optional, string): Poll question
- `answers` (optional, string): Answer options, comma-separated
- `active` (optional, string enum[True, False]): Is poll active

### `DELETE` `/polls` — Delete poll

**Parameters:**
- `id` (query, required, integer): Poll ID

---
## Mail Forms

OpenAPI: https://api.ucoz.net/mail-forms-openapi.yaml

API for managing mail forms, fields, and the HTML email template of the uCoz "Mail forms" module. Routes are relative to the base URL `https://{your_domain}/uapi`. Forms: `GET /mail` or `GET /mail/forms` — full list; `GET /mail/forms?id=<id>` — one form. ## Bearer Token authorization All API requests require Bearer token authorization. To use the API you need to: 1. Get a [Bearer token](/en/start.html) (access token) 2. Specify your site domain in the "Server" field below 3. Enter the token in…

**Tags:**
- `Forms`: List and CRUD for mail forms
- `Fields`: Form fields and field order
- `Templates`: HTML email template for a form — get/save and rebuild from fields

| Method | Path | Summary |
|---|---|---|
| `GET` | `/mail` | List mail forms |
| `GET` | `/mail/forms` | List forms or get one form |
| `POST` | `/mail/forms` | Create mail form |
| `PUT` | `/mail/forms` | Update mail form |
| `DELETE` | `/mail/forms` | Delete mail form |
| `GET` | `/mail/fields` | List form fields |
| `POST` | `/mail/fields` | Add field |
| `PUT` | `/mail/fields` | Update field |
| `DELETE` | `/mail/fields` | Delete field |
| `PUT` | `/mail/move` | Move field up or down |
| `GET` | `/mail/tmpl` | Get form HTML template |
| `PUT` | `/mail/tmpl` | Save HTML template |
| `POST` | `/mail/rebuild` | Rebuild HTML template from form fields |

### `GET` `/mail` — List mail forms

Returns all mail forms on the site. Logical method name in module docs: `api_mail_forms_list`. Same response as `GET /mail/forms` without the `id` parameter.

### `GET` `/mail/forms` — List forms or get one form

Without `id` — all mail forms (`api_mail_forms_list`). With `id` — one form (`api_mail_form_get`).

**Parameters:**
- `id` (query, optional, integer): If set, returns one form with this ID

### `POST` `/mail/forms` — Create mail form

Creates a new form. Logical method name: `api_mail_form_add`. Body: `application/x-www-form-urlencoded` or `application/json` (same fields).

**Request body** (`application/x-www-form-urlencoded / application/json`):
- `name` (required, string): Form name
- `emails` (required, string | array): Comma-separated email list (string) or array of addresses in JSON
- `rez` (required, string): Success message text after submission

### `PUT` `/mail/forms` — Update mail form

Updates an existing form. Logical method name: `api_mail_form_edit`. Body: `application/x-www-form-urlencoded` or `application/json`.

**Request body** (`application/x-www-form-urlencoded / application/json`):
- `id` (required, integer): Form ID
- `name` (required, string)
- `emails` (required, string | array): Comma-separated emails or array
- `rez` (required, string)

### `DELETE` `/mail/forms` — Delete mail form

Deletes the form with its fields and template. Logical name: `api_mail_form_delete`.

**Parameters:**
- `id` (query, required, integer): Form ID

### `GET` `/mail/fields` — List form fields

Fields of the specified mail form. Logical name: `api_mail_fields_list`.

**Parameters:**
- `id` (query, required, integer): Mail form ID

### `POST` `/mail/fields` — Add field

Logical name: `api_mail_field_add`. Field types: 1 — text, 2 — multiline text, 3 — checkbox, 4 — radio, 5 — list, 6 — file, 7 — security (captcha), 8 — policy. Body: `application/x-www-form-urlencoded` or `application/json`.

**Request body** (`application/x-www-form-urlencoded / application/json`):
- `id` (required, integer): Mail form ID
- `type` (required, integer): Field type
- `name` (required, string): Field label
- `required` (required, boolean): Required field
- `values` (optional, string): For types 3, 4, 5 — values, one per line

### `PUT` `/mail/fields` — Update field

Logical name: `api_mail_field_edit`. Body: `application/x-www-form-urlencoded` or `application/json`.

**Request body** (`application/x-www-form-urlencoded / application/json`):
- `id` (required, integer): Mail form ID
- `fid` (required, integer): Field ID
- `type` (required, integer)
- `name` (required, string)
- `required` (required, boolean)
- `values` (optional, string): Value lines for types with options

### `DELETE` `/mail/fields` — Delete field

Logical name: `api_mail_field_delete`.

**Parameters:**
- `id` (query, required, integer): Mail form ID
- `fid` (query, required, integer): Field ID

### `PUT` `/mail/move` — Move field up or down

Changes field order. Logical name: `api_mail_field_move`. `direction`: 0 — up, 1 — down. Body: `application/x-www-form-urlencoded` or `application/json`.

**Request body** (`application/x-www-form-urlencoded / application/json`):
- `id` (required, integer): Mail form ID
- `fid` (required, integer): Field ID
- `direction` (required, integer enum[0, 1]): 0 — up, 1 — down

### `GET` `/mail/tmpl` — Get form HTML template

Logical name: `api_mail_tmpl_get`.

**Parameters:**
- `id` (query, required, integer): Mail form ID

### `PUT` `/mail/tmpl` — Save HTML template

Saves email markup. Logical name: `api_mail_tmpl_save`. Length is limited by the site limit (`mail_mailform_maxlength`). Body: `application/x-www-form-urlencoded` or `application/json`.

**Request body** (`application/x-www-form-urlencoded / application/json`):
- `id` (required, integer): Mail form ID
- `tmpl` (required, string): HTML email template

### `POST` `/mail/rebuild` — Rebuild HTML template from form fields

Regenerates the email template HTML from form field definitions (like the "Rebuild" action in the panel for a form without an installed template). After a successful call, the template file and form flag in storage are updated (flag set to "installed", as after manual rebuild in the panel). Body: `application/x-www-form-urlencoded` or `application/json` — field `id` (mail form ID) is enough.

**Request body** (`application/x-www-form-urlencoded / application/json`):
- `id` (required, integer): Mail form ID for which the template is rebuilt

---
## Search Module

OpenAPI: https://api.ucoz.net/search-openapi.yaml

| Method | Path | Summary |
|---|---|---|
| `GET` | `/search` | Perform search |

### `GET` `/search` — Perform search

Perform a site search. Search can run across modules and content types.

**Parameters:**
- `query` (query, required, string): Search query
- `m` (query, optional, string): Module filter. The parameter can be repeated for several modules (`m=news&m=photo`). Values: `index`/`site`, `blog`, `news`, `publ`, `board`, `stuff`, `dir`, `faq`, `forum`, `gb`, `load`, `photo`, `shop`, `video`.
- `page` (query, optional, integer): Page number (100 at most)
- `per_page` (query, optional, integer): Number of results per page
- `tags` (query, optional, integer enum[0, 1]): Search within tags (1 — yes, 0 — no). `t` is also accepted
- `tag` (query, optional, string): Search by a specific tag (exact tag value)

---
## Site Modules

OpenAPI: https://api.ucoz.net/modules-openapi.yaml

API for installing and uninstalling site modules and managing access to their uAPI methods. ## Bearer Token Authorization All API requests require Bearer token authorization. To use the API: 1. Obtain a [Bearer token](/en/start.html) (access token) 2. Set your site domain in the "Server" field below 3. Enter the token in "Authorize" (button at the bottom right) Catalog, install, and uninstall endpoints (`GET/POST/DELETE /modules/…`) are available only to the site owner — the key must have "cont…

| Method | Path | Summary |
|---|---|---|
| `GET` | `/modules` | Site module catalog |
| `GET` | `/modules/{module}` | Module status |
| `POST` | `/modules/{module}` | Install module |
| `DELETE` | `/modules/{module}` | Uninstall module |
| `GET` | `/active_mods` | Active modules list |

### `GET` `/modules` — Site module catalog

Returns modules that can be managed via API, with current installation state and uAPI access status. Available only to the site owner — the API key must be created on this site in the control panel and have "control panel access" (`can_use_cp`). The `active` field indicates whether the module is installed on the site. The `api_enabled` field indicates whether uAPI methods for this module are allowed. Item order in the response is not guaranteed. Catalog contents depend on the site plan and locale (some modules, for example Yandex feeds, are available only for Russian-language sites).

### `GET` `/modules/{module}` — Module status

Returns the state of a single module: whether it is installed on the site and whether access to its uAPI methods is enabled. Module code — lowercase Latin letters (`news`, `forum`, `shop`, etc.). Requires a site owner Bearer token with control panel access.

**Parameters:**
- `module` (path, required, string): Module code (lowercase Latin letters)

### `POST` `/modules/{module}` — Install module

Installs (activates) a module on the site with default settings — equivalent to installing via the control panel. After successful installation, access to this module's uAPI methods is enabled automatically (`api_enabled: true`). No request body is required. **Common errors:** - `MODULE_ALREADY_ACTIVE` (409) — module is already installed - `MODULE_NOT_AVAILABLE` (403) — module is not available on the current plan or locale - `MODULE_UNKNOWN` (400) — unknown or unsupported module code

**Parameters:**
- `module` (path, required, string): Module code to install

### `DELETE` `/modules/{module}` — Uninstall module

Removes (deactivates) a module from the site. uAPI access for the module is disabled before uninstall. The control panel secret question is **not required** — site owner key ownership replaces that check. Some modules cannot be uninstalled via API (for example, Users, SEO, Subscriptions) — `MODULE_PROTECTED` (403) is returned for them. **Common errors:** - `MODULE_NOT_ACTIVE` (404) — module is not installed - `MODULE_PROTECTED` (403) — uninstall via API is forbidden - `MODULE_UNKNOWN` (400) — unknown module code

**Parameters:**
- `module` (path, required, string): Module code to uninstall

### `GET` `/active_mods` — Active modules list

Returns only **installed** site modules in a simplified format (`code`, `name`). Legacy read-only endpoint for backward compatibility. Standard uAPI Bearer authorization is sufficient — **does not require** control panel access and is not intended for installing or uninstalling modules. For the full catalog with `active` and `api_enabled` flags, use `GET /modules`.

---
## Other Module

OpenAPI: https://api.ucoz.net/other-openapi.yaml

| Method | Path | Summary |
|---|---|---|
| `GET` | `/all_comments` | Get all comments |
| `GET` | `/mysites` | Get site list |
| `GET` | `/ping` | Test request |

### `GET` `/all_comments` — Get all comments

Get all comments from all site modules. Comments per page depend on module settings.

**Parameters:**
- `page` (query, optional, integer): Page number
- `per_page` (query, optional, integer): Comments per page
- `tree` (query, optional, string enum[True, False]): Comment display mode (tree or flat)
- `sort` (query, optional, string enum['asc', 'desc']): Comment sort direction

### `GET` `/mysites` — Get site list

Get sites for the user whose tokens are used in the request.

### `GET` `/ping` — Test request

Run a test request (ping). Response returns OAuth parameters and submitted data.

**Parameters:**
- `param` (query, optional, string): Arbitrary parameter for testing
- `param2` (query, optional, string): Arbitrary parameter for testing

---

## Notes for agents

- Prefer exact parameter names from this file / OpenAPI; do not invent fields.
- Many modules share patterns: entries CRUD, `/category`, `/setup`, comments.
- Shop order status IDs and other enums are listed on the relevant operations.
- Virtual paths like `/shop/editgoods/delete` document POST semantics when HTTP DELETE is not accepted.
- Authoritative specs: `https://api.ucoz.net/*-openapi.yaml`.