Skip to Content
DELETE
/api/v1/accounts/{accountId}

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

Authorization

bearerAuth
headerAuthorizationBearer <token>

Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.

oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.

oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.

Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].

Path Parameters

accountId*string

Account ULID identifier

Query Parameters

purge?|

Set to 'true' to purge immediately bypassing the grace window (system callers only)

Value in"true""false"

Response Body

Account deletion initiated successfully

application/json
  1. response
deleted*boolean

True if the account was soft-deleted

deletedAt*integer

Soft-deletion timestamp in epoch seconds

Formatint64
id*string

Account ULID identifier

purgeAt*integer

Timestamp when the account and its data will be permanently wiped in epoch seconds

Formatint64
restorable*boolean

True if the account can still be restored before purgeAt

Example Request
curl -X DELETE 'https://api.open.email/api/v1/accounts/string'
Example Response
{
  "deleted": true,
  "deletedAt": 0,
  "id": "string",
  "purgeAt": 0,
  "restorable": true
}