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

# Update a mailbox

`PATCH /mailboxes/{id}`

## Request

- Base URL: `https://shipmail.to/api/v1`
- URL: `https://shipmail.to/api/v1/mailboxes/{id}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://shipmail.to/api/auth/oauth2/authorize`, token URL `https://shipmail.to/api/auth/oauth2/token`)

## Headers

- `X-Shipmail-Organization` string

## Request body

- UpdateMailboxRequest
  - `display_name` string, nullable: Display name, or null to clear.

## Response `200`

Updated mailbox.

- Mailbox
  - `object` 'mailbox', required
  - `id` string, required
  - `domain_id` string, required
  - `address` string, required
  - `display_name` string, nullable, required
  - `suspended_at` string, date-time, nullable, required: When the mailbox was suspended. Null if active.
  - `suspension_reasons` string[], required: Independent reasons currently keeping the mailbox suspended.
  - `auto_reply` object, required
    - `enabled` boolean, required
    - `subject` string, nullable, required
    - `body` string, nullable, required
    - `from_date` string, date-time, nullable, required
    - `to_date` string, date-time, nullable, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `404`: Resource not found.
- `422`: Validation failed.
- `429`: Rate limit exceeded.

---

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