Skip to main content
POST
Create custom label

Authorizations

x-api-key
string
header
required

API key (sk-proj-…) from Settings → API Keys. Required for sold API calls outside the Mermail console.

Path Parameters

mailboxId
string
required

Mailbox public_id (UUID), hosted alias id, or current email

Body

application/json
name
string
required
Maximum string length: 80
Example:

"VIP"

rules
string
required

Label matching rules text

Example:
color
string | null

Optional hex color

Example:

"#43c9cb"

Response

Success

The response is of type object.