API reference / Connected sessions / Digital wellbeing
Digital wellbeing
Screen time and restricted mode settings.
- Upstream
/tiktok/v1/digital_wellbeing/settings/- Access
- Growth and up
- Runs on
- FullPool
- 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.
account_idstringrequired
A connected account, from /dash/sessions or POST /v1/account/import. For example acc_7Hq2.
settingsobjectrequired
The settings to change. For example {"restricted_mode":false}.
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.