Skip to Content

Delete an account.

Soft-deletes an account, starting a grace period before final data purge.

openemail.accounts.delete(
  accountId: string,
  options?: AccountsDeleteOptions,
): ApiPromise<AccountDeleteResult>

It calls DELETE /accounts/{accountId}: Delete an account in the API reference.

Example

const accountDeleteResult = await openemail.accounts.delete(accountId)

Arguments

ArgumentTypeDescription
accountIdstringAccount ULID identifier. The path's {accountId}.

Options

The last argument, options, a AccountsDeleteOptions, takes:

OptionTypeSent asDescription
purgebooleanquery purgeSet to 'true' to purge immediately bypassing the grace window (system callers only)

Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).

Answer

Awaited, it is the API's JSON, AccountDeleteResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
400validation_failed
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
403system_credentials_required — only a system caller may pass ?purge=true
404Account not found or not accessible to this principal
409transition_in_progress — retry after the lifecycle transition settles
410account_purged — account has already been permanently purged
502upstream_unavailable — lifecycle transition or purge scheduling unavailable
503temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description)

A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.

Types

It names these types of the API, each on a page of its own: AccountDeleteResult.