Skip to Content

Delete email route.

Removes an email address routing rule. Deleting a GROUP also soft-deletes its persona mailbox (the archive and sending identity) — restorable by its ULID for the usual window through POST /identities/:id/restore; re-creating the address mints a fresh persona.

openemail.routes.delete(
  address: string,
  options?: CallOptions,
): ApiPromise<DeletedResult>

It calls DELETE /routes/{address}: Delete email route in the API reference.

Example

const deletedResult = await openemail.routes.delete(address)

Arguments

ArgumentTypeDescription
addressstringFull email address (e.g. 'info@example.com'). The path's {address}.

Options

It takes no options of its own. 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, DeletedResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Route not found or not accessible to this principal
409primary_address_route (with address and mailboxId): the address is that mailbox's primary address, and deleting it would leave the mailbox unable to receive mail or log in under it. Promote another address with PATCH /identities/:id {primaryAddress}, clear it with primaryAddress: null, or delete the mailbox
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: DeletedResult.