Skip to main content
POST
Add Custom Button

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

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

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 | null

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

dynamic_text
boolean
default:false

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

row_id
string | null

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

description
string | null

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

Maximum string length: 200

Response

Successful Response

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

type
enum<string>
required

Тип кнопки

Available options:
builtin,
url,
mini_app,
callback
text
Text · object
required

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

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 | null

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

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

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