---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Erase address on a mailbox"
description: "`notify.mailboxes.erase_address` (POST /v1/{name}:eraseAddress): Removes an address's personal data from every inbound email of the mailbox that it sent or that names it, keeping the dedupe keys so a poll never brings the mail back."
type: reference
product: email
summary: "Removes an address's personal data from every inbound email of the mailbox that it sent or that names it, keeping the dedupe keys so a poll…"
updated: 2026-09-28
nav: false
---

Removes an address's personal data from every inbound email of the mailbox that it sent or that names it, keeping the dedupe keys so a poll never brings the mail back.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes/mailbox:eraseAddress`
- **Scope** `notify:write`
- **Effect** `destructive` — a successful call removes data; the CLI asks before it runs.
- **Collection** [mailboxes](/docs/api/mailboxes)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The name of the mailbox. Required. |
| `address` | `string` | The email address whose data is removed. Required. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `erased_count` | `int64` | How many inbound emails were scrubbed. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`IDEMPOTENCY_KEY_REUSED`](/docs/api/errors/IDEMPOTENCY_KEY_REUSED) — An Idempotency-Key was reused with another body.
- [`IDEMPOTENCY_IN_PROGRESS`](/docs/api/errors/IDEMPOTENCY_IN_PROGRESS) — The first call with this Idempotency-Key is still running.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes/mailbox:eraseAddress" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"address":"…"}'
```

**TypeScript**

```ts
const response = await sylphx.notify.mailboxes.eraseAddress({ address: '…', name: 'orgs/acme/projects/shop/envs/production/mailboxes/mailbox' })
```

**Rust**

```rust
let mut req = sylphx::notify::EraseMailboxAddressRequest::default();
req.address = "…".to_string();
req.name = "orgs/acme/projects/shop/envs/production/mailboxes/mailbox".to_string();
let response = sx.notify().mailboxes().erase_address(req).await?;
```

**CLI**

```bash
sylphx notify mailboxes erase-address orgs/acme/projects/shop/envs/production/mailboxes/mailbox --yes
```

**MCP**

```json
{ "method_id": "notify.mailboxes.erase_address", "args": {"address":"…","name":"orgs/acme/projects/shop/envs/production/mailboxes/mailbox"} }
```