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

# Update a mailbox

`PATCH /mailboxes/{address}`

## Request

- Base URL: `https://faivelo.com/api/v1`
- URL: `https://faivelo.com/api/v1/mailboxes/{address}`
- Auth: HTTP bearer

Toggle active status and/or change the display name. At least one field is required. Requires scope `mailboxes:write`.

## Path parameters

- `address` string, required

## Request body

- UpdateMailboxRequest: Request body for updating a mailbox. At least one field is required.
  - `active` boolean: Enable or disable the mailbox
  - `displayName` string: The From name recipients see on mail from this mailbox; "" clears it (mail then shows the domain default, else the bare address)

## Response `200`

Updated mailbox

- object
  - `success` boolean
  - `data` Mailbox: Mailbox details
    - `localPart` string
    - `fullAddress` string
    - `displayName` string, nullable
    - `active` boolean
    - `createdAt` string, date-time
    - `storage` object, nullable: On `GET /mailboxes/{address}` only: bytes used and the quota the mail server enforces, read live. Null when the server could not answer.
      - `usedBytes` integer
      - `limitBytes` integer, nullable
      - `availableBytes` integer, nullable

## Other responses

- `401`: Missing or invalid API key
- `402`: The account's plan does not include the API (`plan_required`)
- `403`: The key lacks the required scope
- `404`: Resource not found
- `429`: Rate limit exceeded

---

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