Create an AI label rule

POST/ai-label-rules

Creates the AI label and the natural-language condition that applies it, in one call.

Setting autoReplyEnabled: true lets Maylee send replies on your behalf: it requires allowOutboundSend on the key, like sending an email does.

Authorization

apiKey

AuthorizationBearer <token>

Send your key as Authorization: Bearer mk_…. Session cookies are never accepted on this surface.

In: header

Header Parameters

Idempotency-Key?string

A unique value per operation, such as a UUID. Replays the stored response for 24h. Reusing a key with a different body returns 409.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

autoDraftEnabled?boolean

Auto-draft: Maylee prepares a reply draft for matching emails, for a person to review. Requires a subscription (402 PLAN_REQUIRED otherwise).

autoReplyConfidenceThreshold?integer

The reply is sent only when Maylee's confidence reaches this value (0 to 100); otherwise it stays in Drafts for review.

Range0 <= value <= 100

autoReplyDelayMinutes?integer

Minutes to wait before sending (0 to 15), so that the user can cancel.

Range0 <= value <= 15

autoReplyEnabled?boolean

Auto-reply: Maylee sends the draft prepared by auto-draft without review, so it only works together with autoDraftEnabled. Requires a subscription and the Send emails permission on the key.

autoReplyNotifyOnSend?boolean

Stored with the rule. It has no effect today.

color*string

Color name. The Maylee app renders Pink, Blue, Red, Yellow, Green, Purple and Orange; any other value is stored but shown without color.

condition*string

Plain-language condition that Maylee checks on every new incoming email, for example "Invoices, receipts or payment reminders from suppliers".

Length1 <= length <= 500

hideFromInbox?boolean

Emails that receive this label leave the main inbox. They stay in INBOX, listable with GET /emails?filtered=only.

name*string

Name of the AI label, unique among all labels of the workspace (manual and AI).

Length1 <= length <= 50

Response Body

`application/json`

curl -X POST "https://example.com/ai-label-rules" \  -H "Authorization: Bearer $MAYLEE_KEY" \  -H "Idempotency-Key: $(uuidgen)" \  -H "Content-Type: application/json" \  -d '{    "color": "Green",    "condition": "The email is an invoice, a receipt or a payment confirmation from a supplier.",    "hideFromInbox": true,    "name": "Invoices"  }'

{  "rule": {    "autoDraftEnabled": true,    "autoReplyConfidenceThreshold": 85,    "autoReplyDelayMinutes": 0,    "autoReplyEnabled": false,    "autoReplyNotifyOnSend": true,    "condition": "The sender asks about pricing, a quote or a demo of our product.",    "createdAt": "2026-06-03T08:00:00.000Z",    "hideFromInbox": false,    "id": "cmrl1a2b3c4d5e6f7g8h9i0j",    "label": {      "color": "Blue",      "id": "cmtgai1b2c3d4e5f6g7h8i9j",      "isAiLabel": true,      "name": "Sales"    },    "updatedAt": "2026-08-20T16:40:00.000Z"  }}

Create an AI label rule

AuthorizationCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

201application/json

400application/json

401application/json

403application/json

409application/json

429application/json

Authorization

Header Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`