---
title: "Update a mailbox"
method: PATCH
path: "/v1/mailboxes/{id}"
tags: ["mailboxes"]
---

# Update a mailbox

`PATCH /v1/mailboxes/{id}`

## Request

- Base URL: `https://api.replylayer.ai`
- URL: `https://api.replylayer.ai/v1/mailboxes/{id}`
- Auth: HTTP bearer

## Path parameters

- `id` string, required

## Request body

- object
  - `agent_authoring_mode` 'send_and_draft' | 'draft_only' | 'read_only'
  - `agent_send_containment` boolean
  - `agent_send_policy` 'restricted' | 'open'
  - `allow_thread_replies` boolean
  - `apply_policy_mode` 'read_only' | 'draft_only' | 'supervised' | 'trusted'
  - `approval_expiry` '24h' | '72h' | '7d' | 'never'
  - `confirm_open_human_sends` boolean
  - `default_subaddress_mode` 'reply_to' | 'from' | 'none'
  - `display_name` string, nullable
  - `force_empty` boolean
  - `hitl_mode` 'disabled' | 'all_outbound' | 'risky_only'
  - `pii_mode` 'passthrough' | 'redacted'
  - `pii_redaction_config` object, nullable
  - `reauth_challenge` string
  - `reauth_token` string
  - `recipient_policy_mode` 'blocklist' | 'allowlist'
  - `scanner_policy` union
    - object
      - `disabled_proxy_criteria` string[]
      - `disabled_scanners` string[]
      - `language_mode` 'english_only' | 'allow_all_languages' | 'disabled'
      - `outbound_pii_policy` object
        - `credit_card` 'allow' | 'allow_with_warning' | 'review' | 'quarantine' | 'block'
        - `phone_number` 'allow' | 'allow_with_warning' | 'review' | 'quarantine' | 'block'
        - `ssn` 'allow' | 'allow_with_warning' | 'review' | 'quarantine' | 'block'
      - `outbound_review_policy` object
        - `approval_note` 'optional' | 'required_for_sensitive_pii'
    - unknown
  - `send_window` union
    - object
      - `days` string[], required
      - `end` string, required
      - `outside_action` 'require_approval' | 'block', required
      - `start` string, required
      - `timezone` string, required
    - unknown

## Response `200`

Success

- object
  - `address` string, required
  - `agent_authoring_mode` 'send_and_draft' | 'draft_only' | 'read_only', required
  - `agent_send_containment` boolean, required
  - `agent_send_policy` 'restricted' | 'open', required
  - `allow_thread_replies` boolean, required
  - `attachment_access_accepted_at` string, date-time, nullable, required
  - `attachment_access_accepted_version` string, nullable, required
  - `attachment_access_enabled` boolean, required
  - `attachment_allowed_file_families` string[], required
  - `attachment_exposure_mode` 'metadata_only' | 'derived_content' | 'raw_download_selected_types', required
  - `attachment_image_access_accepted_at` string, date-time, nullable, required
  - `attachment_image_access_accepted_version` string, nullable, required
  - `attachment_policy_version` string, nullable, required
  - `attachment_reauth_at` string, date-time, nullable, required
  - `current_disclaimer_version` string, required
  - `current_image_risk_version` string, required
  - `default_subaddress_mode` 'reply_to' | 'from' | 'none', required
  - `display_name` string, nullable, required
  - `effective_from_display` string, required
  - `hitl_mode` 'disabled' | 'all_outbound' | 'risky_only', required
  - `id` string, required
  - `image_raw_download_confirmed` boolean, required
  - `last_applied_policy_mode` string, nullable, required
  - `legacy_wildcard_active` boolean, required
  - `name` string, required
  - `pii_mode` 'passthrough' | 'redacted', required
  - `pii_redaction_config` object, nullable, required
  - `recipient_policy_mode` 'blocklist' | 'allowlist', required
  - `restricted_by` 'mailbox_allowlist' | 'agent_containment' | 'null', nullable, required
  - `scanner_policy` object, nullable
  - `send_window` object, nullable, required
  - `sender_policy_mode` 'blocklist' | 'allowlist', required

## Other responses

- `400`: Validation error
- `401`: Missing or invalid API key (code: UNAUTHORIZED)
- `403`: Forbidden
- `404`: Not found
- `409`: Conflict
- `422`: Unprocessable entity
- `429`: Rate limited (code: RATE_LIMITED)
- `500`: Internal error (code: INTERNAL_ERROR)

---

[API](https://skmtc.dev/replylayer/apis/replylayer-api.md) · [All operations](https://skmtc.dev/replylayer/apis/replylayer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/replylayer/apis/replylayer-api/revisions/2cae6fbd127e?raw)