Rules Engine API

Build priority-ordered conditional routing rules, evaluate message metadata and spam metrics, and trigger automated forwarding, dropping, or webhook dispatching.

Quick Reference

Rule Evaluation Model

The Rules Engine intercepts inbound transactions immediately after address resolution and evaluates messages against your workspace's rule chain:

1. Priority Pipeline: Rules run in sequence starting from priority: 1.
2. Compound Logic: Each rule specifies match_type: "ALL" (logical AND) or match_type: "ANY" (logical OR) across up to 20 conditions.
3. Execution Halting (stop_processing): When set to true, a matched rule terminates the pipeline immediately. Lower-priority rules will not run for that message.
4. Action Composition: A single rule can execute up to 10 combined actions simultaneously (e.g. inject custom headers, strip tracking beacons, and dispatch a webhook).

Supported Condition Fields & Operators

Evaluated Fields

Comparison Operators

is · is_not · contains · does_not_contain · starts_with · ends_with · matches_regex · exists · not_exists · greater_than · less_than

Supported Action Types

GET /v1/rules — List Routing Rules

Scope: rules:read · Rate Limit: 60/min · Idempotent: Yes

Returns all routing rules configured for your workspace ordered by evaluation priority.

Example Request

curl -X GET "https://api.aliasfleet.com/v1/rules" \
  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \
  -H "Accept: application/json"

Response (200 OK)

{
  "rules": [
    {
      "id": "7b8c9d0e-1f2a-3b4c-5d6e-7f8a9b0c1d2e",
      "name": "Quarantine High Spam Inbound",
      "description": "Quarantine messages failing SPF or carrying high spam scores",
      "is_active": true,
      "priority": 1,
      "match_type": "ANY",
      "stop_processing": true,
      "conditions": [
        {
          "field": "spf_status",
          "operator": "is",
          "value": "fail"
        },
        {
          "field": "spam_score",
          "operator": "greater_than",
          "value": "6.5"
        }
      ],
      "actions": [
        {
          "action_type": "quarantine"
        }
      ],
      "created_at": "2026-08-28T14:00:00.000Z",
      "updated_at": "2026-08-28T14:00:00.000Z"
    }
  ]
}

POST /v1/rules — Create Routing Rule

Scope: rules:write · Rate Limit: 30/min · Idempotent: No

Creates a new conditional routing rule and positions it within the evaluation pipeline.

Request Body Parameters

Example Request

curl -X POST "https://api.aliasfleet.com/v1/rules" \
  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "VIP Billing Forwarder",
    "description": "Reroute financial correspondence to finance inbox with subject tag",
    "priority": 2,
    "match_type": "ALL",
    "stop_processing": false,
    "conditions": [
      {
        "field": "subject",
        "operator": "contains",
        "value": "Invoice"
      },
      {
        "field": "from_domain",
        "operator": "is",
        "value": "accounting-partner.com"
      }
    ],
    "actions": [
      {
        "action_type": "reroute_to",
        "destination_id": "dest_adn6UTmkzn6OWpGq"
      },
      {
        "action_type": "add_subject_prefix",
        "prefix": "[FINANCE]"
      }
    ]
  }'

Response (201 Created)

{
  "message": "Rule created successfully",
  "rule": {
    "id": "3e4f5a6b-7c8d-9e0f-1a2b-3c4d5e6f7a8b",
    "name": "VIP Billing Forwarder",
    "description": "Reroute financial correspondence to finance inbox with subject tag",
    "is_active": true,
    "priority": 2,
    "match_type": "ALL",
    "stop_processing": false,
    "conditions": [
      {
        "field": "subject",
        "operator": "contains",
        "value": "Invoice"
      },
      {
        "field": "from_domain",
        "operator": "is",
        "value": "accounting-partner.com"
      }
    ],
    "actions": [
      {
        "action_type": "reroute_to",
        "destination_id": "dest_adn6UTmkzn6OWpGq"
      },
      {
        "action_type": "add_subject_prefix",
        "prefix": "[FINANCE]"
      }
    ],
    "created_at": "2026-09-04T12:00:00.000Z",
    "updated_at": "2026-09-04T12:00:00.000Z"
  }
}

Errors

GET /v1/rules/:id — Inspect Routing Rule

Scope: rules:read · Rate Limit: 60/min · Idempotent: Yes

Retrieves the complete configuration, conditions, and actions for a single routing rule.

Path Parameters

Example Request

curl -X GET "https://api.aliasfleet.com/v1/rules/3e4f5a6b-7c8d-9e0f-1a2b-3c4d5e6f7a8b" \
  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \
  -H "Accept: application/json"

Response (200 OK)

{
  "rule": {
    "id": "3e4f5a6b-7c8d-9e0f-1a2b-3c4d5e6f7a8b",
    "name": "VIP Billing Forwarder",
    "is_active": true,
    "priority": 2,
    "match_type": "ALL",
    "stop_processing": false,
    "conditions": [
      {
        "field": "subject",
        "operator": "contains",
        "value": "Invoice"
      }
    ],
    "actions": [
      {
        "action_type": "reroute_to",
        "destination_id": "dest_adn6UTmkzn6OWpGq"
      }
    ]
  }
}

Errors

PATCH /v1/rules/:id — Update Routing Rule

Scope: rules:write · Rate Limit: 60/min · Idempotent: Yes

Modifies an existing routing rule. Unspecified fields remain unchanged.

Request Body Parameters

Example Request

curl -X PATCH "https://api.aliasfleet.com/v1/rules/3e4f5a6b-7c8d-9e0f-1a2b-3c4d5e6f7a8b" \
  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \
  -H "Content-Type: application/json" \
  -d '{
    "is_active": false
  }'

Response (200 OK)

{
  "message": "Rule updated successfully",
  "rule": {
    "id": "3e4f5a6b-7c8d-9e0f-1a2b-3c4d5e6f7a8b",
    "name": "VIP Billing Forwarder",
    "is_active": false,
    "priority": 2
  }
}

DELETE /v1/rules/:id — Delete Routing Rule

Scope: rules:write · Rate Limit: 60/min · Idempotent: Yes

Permanently deletes a routing rule and releases its quota allocation.

Path Parameters

Example Request

curl -X DELETE "https://api.aliasfleet.com/v1/rules/3e4f5a6b-7c8d-9e0f-1a2b-3c4d5e6f7a8b" \
  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e"

Response (200 OK)

{
  "message": "Rule deleted successfully"
}

POST /v1/rules/reorder — Reorder Rule Priority Chain

Scope: rules:write · Rate Limit: 30/min · Idempotent: Yes

Atomically reorganizes the priority sequence of all routing rules in your workspace. The index of each ID in the provided array defines its new priority value (index 0 becomes priority 1).

Request Body Parameters

Example Request

curl -X POST "https://api.aliasfleet.com/v1/rules/reorder" \
  -H "Authorization: Bearer afp_4a8f9c1b2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e" \
  -H "Content-Type: application/json" \
  -d '{
    "rule_ids": [
      "7b8c9d0e-1f2a-3b4c-5d6e-7f8a9b0c1d2e",
      "3e4f5a6b-7c8d-9e0f-1a2b-3c4d5e6f7a8b"
    ]
  }'

Response (200 OK)

{
  "message": "Rules reordered successfully",
  "count": 2
}

Errors