Skip to Content

Delete a push subscription.

Stops pushes to this device immediately. A device that unsubscribed locally should also delete its registration; a device that merely lost its endpoint (the push service answers 404/410) is cleaned up automatically. Requires a mailbox app password (oemp_…): subscriptions belong to the credential that creates them, so account and system keys are refused with 403 mailbox_credential_required.

openemail.pushSubscriptions.delete(
  id: string,
  options?: CallOptions,
): ApiPromise<DeletedResult>

It calls DELETE /push-subscriptions/{id}: Delete a push subscription in the API reference.

Example

const deletedResult = await openemail.pushSubscriptions.delete(id)

Arguments

ArgumentTypeDescription
idstringPush subscription ULID. The path's {id}.

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
403mailbox_credential_required
404No such subscription for this credential, or already expired
503temporary_failure (with Retry-After): under the object directory, the account's identity census could not be updated just now, so the write that would move it was not made; retry the same request after the Retry-After window

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.