400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
It starts unpublished with the template's starter draft. The bot must be connected to its channel (409 not_connected). form_preset only applies to the form template. Needs admin permission. Scope: miniapps:write.
Optional, 1-255 visible ASCII characters. Within 24 hours the same key and body return the first response unchanged; a different body returns 409 idempotency_conflict.len 1–255
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
404The record doesn't exist or this key can't access it (not_found).
409The action isn't possible in this state; the code gives the reason.not_connected
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
404The record doesn't exist or this key can't access it (not_found).
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
404The record doesn't exist or this key can't access it (not_found).
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
If notify is true the customer gets a status message through the bot; this also requires the messages:send scope. If the status changes but the notification can't be sent, the response is still 200 and data.notification holds { sent: false, error }. Scope: write.
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
404The record doesn't exist or this key can't access it (not_found).
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
404The record doesn't exist or this key can't access it (not_found).
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
The published version doesn't change; your changes appear once you publish. config must match the template's schema, otherwise 400 miniapp_invalid is returned. Needs admin permission. Scope: miniapps:write.
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).miniapp_invalid
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
404The record doesn't exist or this key can't access it (not_found).
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
The app, its versions and its submissions are permanently deleted; if it's on the menu button, the Telegram menu returns to its default. Needs admin permission. Scope: miniapps:write.
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
404The record doesn't exist or this key can't access it (not_found).
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
A new immutable version is created from the draft and goes public; if publish approval is on, the version waits for approval and the live version doesn't change. If the plan doesn't include Mini Apps it returns 403 plan_limit; an invalid draft returns 400 miniapp_invalid. Needs admin permission. Scope: miniapps:write.
Optional, 1-255 visible ASCII characters. Within 24 hours the same key and body return the first response unchanged; a different body returns 409 idempotency_conflict.len 1–255
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).miniapp_invalid
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.plan_limit
404The record doesn't exist or this key can't access it (not_found).
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
The public page closes; if it's on the menu button, the Telegram menu returns to its default. Versions aren't deleted. Needs admin permission. Scope: miniapps:write.
Optional, 1-255 visible ASCII characters. Within 24 hours the same key and body return the first response unchanged; a different body returns 409 idempotency_conflict.len 1–255
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
404The record doesn't exist or this key can't access it (not_found).
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
The given version goes live again and the draft doesn't change. If the plan doesn't include Mini Apps it returns 403 plan_limit; a version from another app returns 404. Needs admin permission. Scope: miniapps:write.
Optional, 1-255 visible ASCII characters. Within 24 hours the same key and body return the first response unchanged; a different body returns 409 idempotency_conflict.len 1–255
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.plan_limit
404The record doesn't exist or this key can't access it (not_found).
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
enabled: true points the bot's menu button at this app (it must be published); false returns it to the default. A bot has one menu button. Returns 409 if the app isn't published or the bot isn't connected, and 502 if Telegram rejects it. Needs admin permission. Scope: miniapps:write.
Optional, 1-255 visible ASCII characters. Within 24 hours the same key and body return the first response unchanged; a different body returns 409 idempotency_conflict.len 1–255
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
404The record doesn't exist or this key can't access it (not_found).
409The action isn't possible in this state; the code gives the reason.
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
502A channel or external service failed (channel_error).
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
404The record doesn't exist or this key can't access it (not_found).
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
Returns a signed address showing the draft, valid for 2 hours, and the draft configuration. Only share the address with people you trust. If the draft is invalid, valid is false and errors is filled in. Scope: miniapps:read.
Scope
miniapps:read
SDK method
getMiniAppPreview · get_mini_app_preview
MCP tool
getMiniAppPreviewread-only
Parameters
Name
Type
Required
Description
idpath
uuid
yes
ID
Example request
curl -X GET "https://hiboty.com/api/v1/miniapps/3fa85f64-5717-4562-b3fc-2c963f66afa6/preview" \
-H "Authorization: Bearer $HIBOTY_API_KEY"
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
404The record doesn't exist or this key can't access it (not_found).
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
Newest first. The member role only sees orders of bots it can access. Telegram Stars refunds aren't in the API: they're an irreversible money movement, so they're done in the dashboard. Scope: miniapps:read.
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
Imports a Google Merchant XML/RSS, CSV or JSON feed into the draft of a catalog Mini App; send either url or content. The first 50 products are taken and the rest are reported in warnings; Stars prices and delivery content of products with the same ID are kept. The published version doesn't change; publishing is manual. With dry_run true only a preview is returned. With auto_refresh true the address is stored and the draft is refreshed once a day. With ai_knowledge true the catalog is also written to the bot's AI knowledge. The address must be public; internal network addresses return 400 feed_invalid. At most 30 requests per hour. Needs admin permission. Scope: miniapps:write.
Optional, 1-255 visible ASCII characters. Within 24 hours the same key and body return the first response unchanged; a different body returns 409 idempotency_conflict.len 1–255
Body fields
Name
Type
Required
Description
url
string
no
Public http/https feed addresslen ≤ 2000
content
string
no
The feed itself (file content)len ≤ 2000000
format
enum
no
Detected from the content when omittedxml | csv | json
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).feed_invalid
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
404The record doesn't exist or this key can't access it (not_found).
409The action isn't possible in this state; the code gives the reason.
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
The content fingerprint (config_sha256) is checked and the version goes live; if it doesn't match, 409 integrity is returned. If the plan doesn't include Mini Apps it returns 403 plan_limit. Needs admin permission. With four-eyes on, the person who made the change can't approve it (403 four_eyes); approval isn't possible with an API key. Scope: miniapps:write.
Scope
miniapps:write
SDK method
approveMiniAppVersion · approve_mini_app_version
MCP tool
approveMiniAppVersionexternal effect
Parameters
Name
Type
Required
Description
idpath
uuid
yes
ID
version_idpath
uuid
yes
version_id
Example request
curl -X POST "https://hiboty.com/api/v1/miniapps/3fa85f64-5717-4562-b3fc-2c963f66afa6/versions/3fa85f64-5717-4562-b3fc-2c963f66afa6/approve" \
-H "Authorization: Bearer $HIBOTY_API_KEY"
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.plan_limitfour_eyes
404The record doesn't exist or this key can't access it (not_found).
409The action isn't possible in this state; the code gives the reason.integrity
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
401The API key is missing, invalid or revoked (unauthorized).
403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
404The record doesn't exist or this key can't access it (not_found).
429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.