Add Custom Button

Добавить кастомную кнопку (URL, MiniApp или callback).

POST /menu-layout/buttons

Add Custom Button

cURL

curl --request POST \
  --url https://api.example.com/menu-layout/buttons \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "id": "<string>",
  "text": {},
  "action": "<string>",
  "icon": "<string>",
  "visibility": "all",
  "conditions": {
    "has_active_subscription": true,
    "subscription_is_active": true,
    "has_traffic_limit": true,
    "is_admin": true,
    "is_moderator": true,
    "referral_enabled": true,
    "contests_visible": true,
    "support_enabled": true,
    "language_selection_enabled": true,
    "happ_enabled": true,
    "simple_subscription_enabled": true,
    "show_trial": true,
    "show_buy": true,
    "has_saved_cart": true,
    "min_balance_kopeks": 1,
    "max_balance_kopeks": 1,
    "min_registration_days": 1,
    "max_registration_days": 1,
    "min_referrals": 1,
    "has_referrals": true,
    "promo_group_ids": [
      "<string>"
    ],
    "exclude_promo_group_ids": [
      "<string>"
    ],
    "has_subscription_days_left": 1,
    "max_subscription_days_left": 1,
    "is_trial_user": true,
    "has_autopay": true
  },
  "dynamic_text": false,
  "row_id": "<string>",
  "description": "<string>"
}
'

201

{
  "text": {},
  "action": "<string>",
  "builtin_id": "<string>",
  "icon": "<string>",
  "enabled": true,
  "visibility": "all",
  "conditions": {
    "has_active_subscription": true,
    "subscription_is_active": true,
    "has_traffic_limit": true,
    "is_admin": true,
    "is_moderator": true,
    "referral_enabled": true,
    "contests_visible": true,
    "support_enabled": true,
    "language_selection_enabled": true,
    "happ_enabled": true,
    "simple_subscription_enabled": true,
    "show_trial": true,
    "show_buy": true,
    "has_saved_cart": true,
    "min_balance_kopeks": 1,
    "max_balance_kopeks": 1,
    "min_registration_days": 1,
    "max_registration_days": 1,
    "min_referrals": 1,
    "has_referrals": true,
    "promo_group_ids": [
      "<string>"
    ],
    "exclude_promo_group_ids": [
      "<string>"
    ],
    "has_subscription_days_left": 1,
    "max_subscription_days_left": 1,
    "is_trial_user": true,
    "has_autopay": true
  },
  "dynamic_text": false,
  "open_mode": "callback",
  "webapp_url": "<string>",
  "description": "<string>",
  "sort_order": 123
}

Authorizations

X-API-Key · string · header · required

Body

application/json

Запрос на добавление кастомной кнопки.

id · string · required

ID кнопки (уникальный)

Required string length: 1 - 50

type · enum<string> · required

Тип кнопки (url, mini_app или callback)

Available options: builtin, url, mini_app, callback

text · Text · object · required

Локализованные тексты

Show child attributes

action · string · required

URL или callback_data

Minimum string length: 1

icon · string | null

Эмодзи/иконка кнопки

Maximum string length: 10

visibility · enum<string> · default: all

Видимость

Available options: all, admins, moderators, subscribers

conditions · ButtonConditions · object

Условия показа

Show child attributes

dynamic_text · boolean · default: false

Текст содержит плейсхолдеры

row_id · string | null

ID строки для добавления кнопки

description · string | null

Описание кнопки для админ-панели

Maximum string length: 200

Response

201

application/json

Successful Response

Конфигурация отдельной кнопки.

type · enum<string> · required

Тип кнопки

Available options: builtin, url, mini_app, callback

text · Text · object · required

Локализованные тексты кнопки: {lang_code: text}

Show child attributes

action · string · required

callback_data или URL в зависимости от типа

builtin_id · string | null

ID встроенной кнопки (для type=builtin)

icon · string | null

Эмодзи/иконка кнопки (отдельно от текста)

Maximum string length: 10

enabled · boolean · default: true

Кнопка активна

visibility · enum<string> · default: all

Видимость кнопки

Available options: all, admins, moderators, subscribers

conditions · ButtonConditions · object

Дополнительные условия показа

Show child attributes

dynamic_text · boolean · default: false

Текст содержит плейсхолдеры ({balance}, {username} и т.д.)

open_mode · enum<string> · default: callback

Режим открытия: callback (через бота) или direct (сразу Mini App)

Available options: callback, direct

webapp_url · string | null

URL для Mini App при open_mode=direct

description · string | null

Описание кнопки для админ-панели

Maximum string length: 200

sort_order · integer | null

Порядок сортировки (для отображения в админке)