# REST: onboarding

Source: <https://telegafirst.com/docs/api-onboarding>
Locale: ru
releaseGitSha: 0bb11ef116e17ec64c802d5476eaff442e53d252
sourceContentDigest: 57408b49284bdffc3ee3d94c4cf248af25f9567346570625f1a27c4f15534d10
Version: 9

# REST: onboarding

Выберите операцию: полный контракт доступен по ссылке. Scopes: ALL; auth alternatives: OR.

## saveAiPreferences

`POST /api/v1/tools/onboarding/ai-preferences` — saveAiPreferences

Scopes (ALL): \["onboarding:write"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-saveaipreferences)

## getBillingState

`GET /api/v1/tools/onboarding/billing` — getBillingState

Scopes (ALL): \["onboarding:read"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-getbillingstate)

## cancelAutoRenew

`POST /api/v1/tools/onboarding/billing/cancel-auto-renew` — cancelAutoRenew

Scopes (ALL): \["onboarding:write"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-cancelautorenew)

## sendTariffCheckoutCard

`POST /api/v1/tools/onboarding/billing/checkout-card` — sendTariffCheckoutCard

Scopes (ALL): \["onboarding:write"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-sendtariffcheckoutcard)

## deferTariff

`POST /api/v1/tools/onboarding/billing/defer` — deferTariff

Scopes (ALL): \["onboarding:write"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-defertariff)

## resumeBotConnection

`POST /api/v1/tools/onboarding/bot-connection/resume` — resumeBotConnection

Scopes (ALL): \["onboarding:write"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-resumebotconnection)

## getCatalogTopicLink

`GET /api/v1/tools/onboarding/catalog-topic-link` — getCatalogTopicLink

Scopes (ALL): \["onboarding:read"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-getcatalogtopiclink)

## connectChannel

`POST /api/v1/tools/onboarding/channel/connect` — connectChannel

Scopes (ALL): \["client-config:write"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-connectchannel)

## completeOnboarding

`POST /api/v1/tools/onboarding/complete` — completeOnboarding

Scopes (ALL): \["onboarding:write"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-completeonboarding)

## registerExistingBot

`POST /api/v1/tools/onboarding/existing-bot` — registerExistingBot

Scopes (ALL): \["onboarding:write"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-registerexistingbot)

## getExistingBotInstructions

`GET /api/v1/tools/onboarding/existing-bot/instructions` — getExistingBotInstructions

Scopes (ALL): \["onboarding:read"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-getexistingbotinstructions)

## deferFirstPayment

`POST /api/v1/tools/onboarding/first-payment/defer` — deferFirstPayment

Scopes (ALL): \["onboarding:write"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-deferfirstpayment)

## executeFirstPayment

`POST /api/v1/tools/onboarding/first-payment/execute` — executeFirstPayment

Scopes (ALL): \["catalog:write","payments:config"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-executefirstpayment)

## prepareFirstPayment

`POST /api/v1/tools/onboarding/first-payment/prepare` — prepareFirstPayment

Scopes (ALL): \["catalog:write","payments:config"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-preparefirstpayment)

## checkFreeConditions

`POST /api/v1/tools/onboarding/free-conditions/check` — checkFreeConditions

Scopes (ALL): \["onboarding:read"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-checkfreeconditions)

## resumeInfrastructure

`POST /api/v1/tools/onboarding/infrastructure/resume` — resumeInfrastructure

Scopes (ALL): \["onboarding:write"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-resumeinfrastructure)

## initManagedBot

`POST /api/v1/tools/onboarding/managed-bot` — initManagedBot

Scopes (ALL): \["onboarding:write"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-initmanagedbot)

## registerMiniAppOrigin

`POST /api/v1/tools/onboarding/mini-app-origin` — registerMiniAppOrigin

Scopes (ALL): \["onboarding:write"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-registerminiapporigin)

## checkPaymentProvider

`POST /api/v1/tools/onboarding/payment-provider/check` — checkPaymentProvider

Scopes (ALL): \["payments:config"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-checkpaymentprovider)

## connectPaymentProvider

`POST /api/v1/tools/onboarding/payment-provider/connect` — connectPaymentProvider

Scopes (ALL): \["payments:config"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-connectpaymentprovider)

## probePaymentProvider

`POST /api/v1/tools/onboarding/payment-provider/probe` — probePaymentProvider

Scopes (ALL): \["payments:config"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-probepaymentprovider)

## confirmPaymentWebhook

`POST /api/v1/tools/onboarding/payment-provider/webhook/confirm` — confirmPaymentWebhook

Scopes (ALL): \["payments:config"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-confirmpaymentwebhook)

## createQuestProduct

`POST /api/v1/tools/onboarding/quest-product` — createQuestProduct

Scopes (ALL): \["onboarding:write"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-createquestproduct)

## checkTestProduct

`GET /api/v1/tools/onboarding/quest-product/check` — checkTestProduct

Scopes (ALL): \["onboarding:read"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-checktestproduct)

## checkTestPurchase

`GET /api/v1/tools/onboarding/quest-purchase/check` — checkTestPurchase

Scopes (ALL): \["onboarding:read"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-checktestpurchase)

## createQuickSite

`POST /api/v1/tools/onboarding/quick-site` — createQuickSite

Scopes (ALL): \["onboarding:write"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-createquicksite)

## retryOnboardingSite

`POST /api/v1/tools/onboarding/site/retry` — retryOnboardingSite

Scopes (ALL): \["onboarding:write"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-retryonboardingsite)

## claimSlug

`POST /api/v1/tools/onboarding/slug` — claimSlug

Scopes (ALL): \["onboarding:write"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-claimslug)

## checkSlugAvailability

`GET /api/v1/tools/onboarding/slug-availability` — checkSlugAvailability

Scopes (ALL): \["onboarding:read"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-checkslugavailability)

## getOnboardingState

`GET /api/v1/tools/onboarding/state` — getOnboardingState

Scopes (ALL): \["onboarding:read"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-getonboardingstate)

## confirmSupergroups

`POST /api/v1/tools/onboarding/supergroups/confirm` — confirmSupergroups

Scopes (ALL): \["onboarding:write"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-confirmsupergroups)

## discoverSupergroups

`GET /api/v1/tools/onboarding/supergroups/discovery` — discoverSupergroups

Scopes (ALL): \["onboarding:read"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-discoversupergroups)

## requestManualSupergroups

`POST /api/v1/tools/onboarding/supergroups/manual-request` — requestManualSupergroups

Scopes (ALL): \["onboarding:write"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-requestmanualsupergroups)

## setTaxProfile

`POST /api/v1/tools/onboarding/tax-profile` — setTaxProfile

Scopes (ALL): \["onboarding:write"]. Auth (OR): \[{"hubApiKey":\[]},{"hubBearer":\[]}].

[Параметры, ответы и права](https://telegafirst.com/docs/api-op-settaxprofile)