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

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

Path parameters

idstring required

Request body

labelstring required

Response

The request has succeeded.

idstring required
labelstring required
engineAccountIdstring 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.

keyPrefixstring 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
createdAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.