Skip to Content
POST
/api/v1/mailboxes/{mailboxId}/labels

Creates a new user folder or label with a fresh UID validity epoch.

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

Request Body

application/json
  1. body
color?|

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

Match^#[0-9a-f]{6}$
name*string

Name for the new label. May not start with *, which clients reserve for their own views

Length1 <= length <= 255

Response Body

Created label details

application/json
  1. response
color*|

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

id*integer

Assigned label ID

Formatint64
name*string

Created label name

uidValidity*integer

Initial UIDVALIDITY epoch for the label

Formatint64
Example Request
curl -X POST 'https://api.open.email/api/v1/mailboxes/string/labels' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'
Example Response
{
  "color": "string",
  "id": 0,
  "name": "string",
  "uidValidity": 0
}