Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Erase address on a mailbox
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…
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
#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— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_FIELD— A field failed validation.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.
Every error arrives in the body Errors describes.
#Examples
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":"…"}'