---
title: "Create Pinned Message"
method: POST
path: "/pinned-messages"
tags: ["pinned-messages"]
---

# Create Pinned Message

`POST /pinned-messages`

## Request

- The document declares no server URL.
- Auth: API key in header `X-API-Key`
- TypeScript: <https://skmtc.dev/bedolagam/apis/remnawave-bot-admin-api/docs/pinned-messages/post.ts> (a function with typed inputs; its response is checked against the schema)

Создать новое закреплённое сообщение.

Автоматически деактивирует предыдущее активное сообщение.
- broadcast=False (по умолчанию): пользователи увидят при следующем /start
- broadcast=True: рассылает сообщение всем активным пользователям сразу

## Query parameters

- `broadcast` boolean: Разослать сообщение всем пользователям (по умолчанию False — только при /start)

## Request body

- AppWebapiSchemasPinnedMessagesPinnedMessageCreateRequest
  - `content` string, required
  - `send_before_menu` boolean
  - `send_on_every_start` boolean
  - `media` AppWebapiSchemasPinnedMessagesPinnedMessageMedia
    - `type` string, required
    - `file_id` string, required

## Response `201`

Successful Response

- PinnedMessageBroadcastResponse
  - `message` PinnedMessageResponse, required
    - `id` integer, required
    - `content` string, nullable, required
    - `media_type` string, nullable
    - `media_file_id` string, nullable
    - `send_before_menu` boolean, required
    - `send_on_every_start` boolean, required
    - `is_active` boolean, required
    - `created_by` integer, nullable
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, nullable
  - `sent_count` integer, required
  - `failed_count` integer, required

## Other responses

- `422`: Validation Error

## Changes

- **2026-11-03** `2360876ff9c5`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bedolagam/apis/remnawave-bot-admin-api/changes/pinned-messages/post.md)

---

[API](https://skmtc.dev/bedolagam/apis/remnawave-bot-admin-api.md) - [All operations](https://skmtc.dev/bedolagam/apis/remnawave-bot-admin-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bedolagam/apis/remnawave-bot-admin-api/revisions/2360876ff9c5?raw)
