Skip to Content
DELETE
/api/v1/mailboxes/{mailboxId}/shares/{granteeIdentityId}

Takes away an identity's access to this mailbox. Access stops immediately — rights are re-read on every request, so a session that is already open loses the mailbox on its next operation rather than at some later expiry.

The read/unread marks that identity had made in this mailbox are their own, and are discarded with the grant. Nothing belonging to the mailbox owner is deleted.

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

mailboxId*string

ULID of the mailbox whose access is being managed

granteeIdentityId*string

ULID of the identity being given (or losing) access

Response Body

The grant was removed

application/json
  1. response
deleted*boolean

True if the resource was successfully deleted

Example Request
curl -X DELETE 'https://api.open.email/api/v1/mailboxes/string/shares/string'
Example Response
{
  "deleted": true
}