---
title: "Update Mailbox"
method: PATCH
path: "/api/v1/mail/mailboxes/{email_address}"
tags: ["Mailboxes"]
---

# Update Mailbox

`PATCH /api/v1/mail/mailboxes/{email_address}`

## Path parameters

- `email_address` string, required

## Request body

- MailboxUpdateRequest
  - `filter_mode` 'whitelist' | 'blacklist'

## Response `200`

Successful Response

- MailboxResponse
  - `id` string, uuid, required
  - `email_address` string, required
  - `status` 'active' | 'paused' | 'deleted'
  - `sending_domain` string — Bare domain the mailbox sends from, derived from email_address. Matches the platform default (inkboxmail.com) or the customer's verified custom domain.
  - `filter_mode` 'whitelist' | 'blacklist', required
  - `agent_identity_id` string, uuid, nullable — ID of the agent identity that owns this mailbox, or null on tombstones / system mailboxes.
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `storage_used_bytes` integer — Live storage used by this inbox, in bytes.
  - `storage_limit_bytes` integer, nullable — Resolved plan-tiered storage cap in bytes; null when the route did not resolve it (the ORM does not carry the cap).
  - `filter_mode_change_notice` FilterModeChangeNotice
    - `new_filter_mode` 'whitelist' | 'blacklist', required
    - `redundant_rule_action` string, required — 'block' or 'allow'; the action whose rules are now redundant.
    - `redundant_rule_count` integer, required — Count of active rules whose action equals redundant_rule_action. 0 = clean flip; >0 = console UI should prompt the operator to review.
  - `unread_count` integer, nullable

## Other responses

- `422` — Validation Error
- `4XX` — Client error with Support Agent information.
- `5XX` — Server error with Support Agent information.

---

[API](https://skmtc.dev/inkbox/apis/inkbox-api.md) · [All operations](https://skmtc.dev/inkbox/apis/inkbox-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/inkbox/inkbox-api/revisions/31f357e7e6f8/schema)