API reference / Connected sessions / Email sign-in: send code

Email sign-in: send code

Send a one-time sign-in code to your account’s email.

POSTapi.tikultra.com/v1/account/login/otp/sendPremium · 25 credits
Upstream
/passport/email/send_code/
Access
Growth and up
Runs on
FullPool
Client
os, app_flavour, app_version selectable
Billing
Failed calls are free

Authorization

x-api-keyheader · stringrequired

Your API key. Create one in API keys.

Body

Send JSON with content-type: application/json.

emailstringrequired

The email on the account. For example [email protected].

osstring

android or ios. One of android, ios.

app_flavourstring

Which app to run as. One of tiktok, lite, lite_coin, pro, studio, shop, tv, douyin.

app_versionstring

A release of that app. Defaults to the current default for (os, app_flavour). For example 47.6.3.

regionstring

Two-letter country code for egress and storefront. For example US.

citystring

A city in that region. See the supported cities list. For example miami.

Response

A 200 returns JSON with stable field names. Every response carries x-credits-cost, x-credits-tier and x-credits-remaining.

Errors

Errors return a JSON body with a stable code and cost 0 credits. See Errors and retries.

Accounts you own only. Connected sessions are for accounts you own or are authorized to operate. Available on Growth and Scale.