Skip to Content
PATCH
/api/v1/mailboxes/{mailboxId}/labels/{label}

Renames a custom label and/or updates its display sort order, subscription state, and color. System labels cannot be renamed, but their sortOrder, isSubscribed, and color settings can still be updated.

withChildren: true carries every Old/… sub-label with the rename, in one commit that is validated whole before it writes — so the tree cannot be left half-renamed. Filter rules naming any moved label follow it, and so do pickup sources that deliver into one. Raw user Sieve scripts are NOT rewritten.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.

oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.

oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.

Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].

Path Parameters

mailboxId*string

Mailbox ULID identifier

label*string

Label or folder name (e.g. INBOX, Archive, custom)

Request Body

application/json
  1. body
color?|

Hex color code for the label badge/chip, or null to clear

Match^#[0-9a-f]{6}$
isSubscribed?boolean

Whether folder is subscribed for client sync

name?string

New label name (custom labels only). May not start with *

Length1 <= length <= 255
sortOrder?integer

Presentation display sort order index

Range0 <= value <= 2147483647
withChildren?boolean

With name, carry every Old/… sub-label along in the same commit. The whole move is validated before any of it is written, so it cannot half-apply. Default false, which leaves sub-labels under their old prefix.

Response Body

Update successful

application/json
  1. response
renamed*boolean

True if the label was successfully renamed

Example Request
curl -X PATCH 'https://api.open.email/api/v1/mailboxes/string/labels/string' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example Response
{
  "renamed": true
}