Emails

Preview email removal

What DELETE /me/emails/{id} would do — the counts the Remove dialog shows — or the reason it is refused. Reads nothing but the account; changes nothing.

get/api/v1/me/emails/{id}/removal-preview

Request

  • Base URL: https://api.proof.holdings
  • URL: https://api.proof.holdings/api/v1/me/emails/{id}/removal-preview
  • Auth: API key in cookie auth_token

Path parameters

idstring required

MongoDB ObjectId

Example:507f1f77bcf86cd799439011

Response

What removing Email would do, or why it is refused (allowed: false)

allowedboolean required

False when a guard refuses the removal; the dialog shows blocked.message in its disabled state.

type'phone' | 'email'
identifierstring

Masked.

is_primaryboolean
proofsinteger

Active proofs of this identifier that would be revoked.

authorizationsinteger

Approval consents naming it that would be revoked.

circlesinteger

Phones only: active Proof of Me circles, which follow the primary phone.

lookalike_watch'repointed' | 'canceled' | 'unchanged'

Emails only: what happens to the Lookalike Watch notification address.

notice_tostring[]

Where the notice would go — captured before the row is gone.

Example response

{
  "identifier": "+1555***1001",
  "new_primary": {
    "id": "507f1f77bcf86cd799439011",
    "identifier": "+1555***2002"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.