Rename a label or update folder settings
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.
bearerAuthAuthorizationBearer <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: [].
mailboxId*stringMailbox ULID identifier
label*stringLabel or folder name (e.g. INBOX, Archive, custom)
application/json- body
color?|Hex color code for the label badge/chip, or null to clear
^#[0-9a-f]{6}$isSubscribed?booleanWhether folder is subscribed for client sync
name?stringNew label name (custom labels only). May not start with *
1 <= length <= 255sortOrder?integerPresentation display sort order index
0 <= value <= 2147483647withChildren?booleanWith 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.
Update successful
application/json- response
renamed*booleanTrue if the label was successfully renamed
curl -X PATCH 'https://api.open.email/api/v1/mailboxes/string/labels/string' \
-H 'Content-Type: application/json' \
-d '{}'{
"renamed": true
}List mailbox labels and folder statistics GET
Returns all system and custom labels with message counts, unread counts, UID validity, and next UID sequence numbers. Listing requires the lookup (`l`) right…
Delete a custom label DELETE
Deletes a custom label. Messages carrying this label will retain any other labels they have. Messages with no other labels are expunged (moved to Recently…