MayleeDevelopers
WebsiteSign up
Auto-forward rules

Update an auto-forward rule

PATCH/auto-forward-rules/{ruleId}

Requires allowOutboundSend on the key. At least one field is required; forwardTo and conditionValue cannot be emptied.

Authorization

apiKey
AuthorizationBearer <token>

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

In: header

Path Parameters

ruleId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/auto-forward-rules/string" \  -H "Authorization: Bearer $MAYLEE_KEY" \  -H "Content-Type: application/json" \  -d '{    "isActive": false  }'
{  "rule": {    "conditionField": "label",    "conditionValue": "Invoices",    "createdAt": "2026-08-01T09:00:00.000Z",    "forwardTo": "accounting@your-company.com",    "id": "cmaf1a2b3c4d5e6f7g8h9i0j",    "isActive": true,    "mode": "normal",    "updatedAt": "2026-08-01T09:00:00.000Z"  }}

Create an auto-forward rule POST

Forwards every incoming email matching the condition to `forwardTo`. A rule makes email leave the workspace: creating, changing or deleting one requires `allowOutboundSend` on the key, like sending does. A key with `write` alone gets `403 OUTBOUND_SEND_NOT_ALLOWED`.

Delete an auto-forward rule DELETE

Requires `allowOutboundSend` on the key.