Account

Delete the account (scheduled 7 days out; cancellable until then).

Schedules the deletion of the account and everything it made: scripts, projects, Series Bibles, outlines and coverage; table reads, decks, trailers and every stored file; shows, their feeds and public pages; voices, here and at the voice provider; API keys, connected apps and sign-ins; stored app logins. Nothing is removed until scheduledFor (7 days); the account owner is emailed and can cancel (DELETE /account/deletion) until the purge starts. Unused Studio Credits are forfeited at the purge. Payment records are kept without a name or email, as tax law requires. Videos on the owner's own YouTube or TikTok channel are listed in the confirmation email for them to remove. confirmEmail must be the account's email address (400 account_email_mismatch; nothing is scheduled). 409 account_deletion_refused for an admin, a workshop host or an organization owner (message says why). A deletion already scheduled is returned unchanged. Requires Idempotency-Key. Scope: account:write. Free.

post/account/deletion

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/account/deletion
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Customer-generated stable identifier for safe retries of idempotent POST requests.

Request body

confirmEmailstring required

The account's email address, to confirm whose account is being deleted.

Response

The deletion is scheduled.

state'none' | 'scheduled' | 'purging' | 'blocked' required
requestedAtstring date-time nullable required
scheduledForstring date-time nullable required

When the purge runs; cancellable until then.

blockedReasonstring nullable required

Why a purge stopped and needs a person (state blocked).

canRequestboolean required
refusalstring nullable required

Why this account cannot delete itself, when it cannot.

deletesstring[] required
keepsstring required
exportNoticestring required
uploadsNoticestring required
graceDaysinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.