Skip to Content

The AccountDeleteResult type of the TypeScript SDK, which accounts.delete take or answer.

type AccountDeleteResult = {
  deleted: boolean
  deletedAt: number
  id: string
  purgeAt: number
  restorable: boolean
}

Fields

FieldTypeDescription
deletedbooleanTrue if the account was soft-deleted
deletedAtnumberSoft-deletion timestamp in epoch seconds
idstringAccount ULID identifier
purgeAtnumberTimestamp when the account and its data will be permanently wiped in epoch seconds
restorablebooleanTrue if the account can still be restored before purgeAt

Used by

MethodWhat it does
accounts.deleteDelete an account

On this page