> ## Documentation Index
> Fetch the complete documentation index at: https://docs.botmux.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Установить титул

> Sets a custom title (badge) for an admin user in a chat.



## OpenAPI

````yaml POST /api/admins/title
openapi: 3.1.0
info:
  title: BotMux API
  description: >
    REST API for BotMux — a multi-bot Telegram management and proxy platform.


    All endpoints return JSON. Errors return `{"error": "message"}` with HTTP
    500 (or 400/401/403/404 where applicable).


    **Authentication**: Use a Bearer API key (`Authorization: Bearer bmx_...`)
    or a session cookie obtained via `/api/auth/login`.
  version: 1.0.0
  contact:
    name: BotMux
servers:
  - url: http://localhost:8080
    description: Local development server
security:
  - BearerAuth: []
  - CookieAuth: []
tags:
  - name: Bots
    description: Bot registration, configuration, and health management
  - name: Chats
    description: Tracked chat management
  - name: Messages
    description: Message retrieval, search, and actions
  - name: Users
    description: Chat member management
  - name: Admins
    description: Chat administrator management
  - name: Tags
    description: User tagging and labels
  - name: Routes
    description: Message routing rules between bots
  - name: Analytics
    description: Chat statistics and metrics
  - name: Audit Log
    description: Administrative action history
  - name: Long Polling
    description: Pull-based update delivery (Telegram-compatible)
  - name: Telegram Proxy
    description: >
      Transparent proxy to api.telegram.org with message capture and method
      interception.


      Several Telegram Bot API methods are intercepted by BotMux instead of
      being forwarded:

      - `setWebhook` — configures the bot's backend URL in BotMux and enables
      proxy mode (auto-registration of unknown tokens requires
      `BOTMUX_ALLOW_AUTO_REGISTER=1`)

      - `deleteWebhook` — clears the backend URL and disables proxy mode

      - `getWebhookInfo` — returns BotMux's internal webhook state

      - `getUpdates` — served from BotMux's internal queue when long polling is
      enabled; returns empty for any other known bot to prevent conflict errors

      - `logOut` — returns success without forwarding (prevents token being
      disabled for 10 minutes)

      - `close` — returns success without forwarding (prevents bot instance
      shutdown on Telegram's side)


      A file download endpoint at `/tgapi/file/bot{TOKEN}/{file_path}` is also
      available as a drop-in replacement for Telegram's file download URL.
paths:
  /api/admins/title:
    post:
      tags:
        - Admins
      summary: Set admin title
      description: Sets a custom title (badge) for an admin user in a chat.
      operationId: setAdminTitle
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminTitleRequest'
            example:
              bot_id: 1
              chat_id: -100123456789
              user_id: 987654321
              title: Moderator
      responses:
        '200':
          description: Title set
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    example: true
        '400':
          description: Invalid request or Telegram API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    AdminTitleRequest:
      type: object
      required:
        - bot_id
        - chat_id
        - user_id
        - title
      properties:
        bot_id:
          type: integer
        chat_id:
          type: integer
        user_id:
          type: integer
        title:
          type: string
          description: Custom admin title (max 16 characters)
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message
      required:
        - error
      example:
        error: bot not found
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key with `bmx_` prefix. Obtain via `/api/auth/api-keys`.
    CookieAuth:
      type: apiKey
      in: cookie
      name: session
      description: Session cookie obtained after login via `/api/auth/login`.

````