---
title: "PATCH /v1/mailboxes/{id}"
method: PATCH
path: "/v1/mailboxes/{id}"
---

# PATCH /v1/mailboxes/{id}

`PATCH /v1/mailboxes/{id}`

## Request

- The document declares no server URL.
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Secure-better-auth.session_token`

Rename a mailbox. Routes, grants and mail are untouched — the label is display only.

## Path parameters

- `id` string, required

## Request body

- MailboxRename
  - `label` string, required

## Response `200`

The request has succeeded.

- Mailbox
  - `id` string, required
  - `label` string, required
  - `engineAccountId` string, nullable, required: The engine account this container lives on. What keeps a caller's correlation wire-level: token props name mailboxes by engine id, and this is that id. Null while `provisioning`, and on a `failed` claim.
  - `keyPrefix` string, nullable, required: The displayable head of this mailbox's engine key. The key itself is minted on the engine and is not held here.
  - `status` 'provisioning' | 'active' | 'failed', required
  - `createdAt` string, date-time, required

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/foundermail/apis/org.md) - [All operations](https://skmtc.dev/foundermail/apis/org/llms.txt) - [OpenAPI document](https://skmtc.dev/foundermail/apis/org/revisions/8bbb36e378ab?raw)