Live Direct Marketing

Live Direct Marketing Mail Routing Rules API

The Mail Routing Rules API from Live Direct Marketing — 4 operation(s) for mail routing rules.

GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/mail-routing-rules List all mail routing rules · List all mail routing rules #
Ask an LLM
“What mail routing rules do I have set up for incoming email?”
“Can I see every inbox routing rule in my workspace at once?”
Tell an agent
List all my mail routing rules.
Show every inbox routing rule configured for tenant {tenant}.
POST /api/mail-routing-rules Create a mail routing rule · Create a new mail routing rule #
Ask an LLM
“How do I automatically move emails from a certain domain into a folder?”
“Can a new routing rule forward matching replies to a colleague?”
Tell an agent
Create a routing rule named {name} that moves mail from {fromDomain} into folder {targetFolder}.
Add a new routing rule {name} that forwards emails with subject matching {subjectPattern} to {forwardTo}.
GET /api/mail-routing-rules/{id} Get a mail routing rule · Get a mail routing rule by id #
Ask an LLM
“What conditions and action does a specific routing rule have?”
“Can I look up the details of one mail routing rule by its id?”
Tell an agent
Show me mail routing rule {id}.
Get the match conditions and target folder of routing rule {id}.
PATCH /api/mail-routing-rules/{id} Update a mail routing rule · Update a mail routing rule #
Ask an LLM
“How do I change the target folder of an existing routing rule?”
“Can I edit the keywords or sort order on a routing rule I already created?”
Tell an agent
Change existing routing rule {id} to move matching mail into {targetFolder}.
Update the keywords on routing rule {id} to {keywords}.
DELETE /api/mail-routing-rules/{id} Delete a mail routing rule · Delete a mail routing rule #
Ask an LLM
“How do I permanently remove a mail routing rule I no longer need?”
“Can I delete an inbox routing rule rather than just disabling it?”
Tell an agent destructive · confirm first
Delete mail routing rule {id}.
Remove routing rule {id} from my inbox rules for good.
PATCH /api/mail-routing-rules/{id}/toggle Turn a mail routing rule on or off · Toggle the active flag of a mail routing rule #
Ask an LLM
“How do I temporarily pause a routing rule without deleting it?”
“Can I flip a disabled mail rule back on with one call?”
Tell an agent
Toggle routing rule {id} on or off.
Flip the active switch on mail routing rule {id}.
POST /api/mail-routing-rules/test Dry-run an email against routing rules · Dry-run a synthetic email against active routing rules #
Ask an LLM
“Which of my active routing rules would catch a given email?”
“Can I test my mail rules with a sample message before it really arrives?”
Tell an agent
Dry-run a sample email through my active routing rules and tell me which one matches.
Test the active mail routing rules against a synthetic message without moving anything.

Documentation

📖
Documentation
https://developers.live-direct-marketing.online/
📖
APIReference
https://developers.live-direct-marketing.online/api-reference
📖
GettingStarted
https://developers.live-direct-marketing.online/quickstart
📖
Authentication
https://developers.live-direct-marketing.online/authentication
📖
Documentation
https://check.live-direct-marketing.online/docs
📖
APIReference
https://check.live-direct-marketing.online/api/docs

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/live-direct-marketing-online/refs/heads/main/openapi/live-direct-marketing-online-mail-routing-rules-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/live-direct-marketing-online/refs/heads/main/data-model/live-direct-marketing-online-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/live-direct-marketing-online:live-direct-marketing-online-mail-routing-rules-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

live-direct-marketing-online-mail-routing-rules-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: LDM v3 Mail Routing Rules API
  description: 'Multi-tenant B2B outreach automation platform. Auth: JWT Bearer (15-min) or tenant API key (ldm_*) managed in CRM Settings → API Keys. All tenant-scoped endpoints require the X-Tenant-Id header.'
  version: 1.0.0
  contact: {}
servers:
- url: https://api.live-direct-marketing.online
  description: Production
- url: https://api.dev.live-direct-marketing.online
  description: Development
- url: http://127.0.0.1:3000
  description: Local
tags:
- name: Mail Routing Rules
paths:
  /api/mail-routing-rules:
    get:
      operationId: MailRoutingController_findAll
      parameters:
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: List all mail routing rules
      tags:
      - Mail Routing Rules
    post:
      operationId: MailRoutingController_create
      parameters:
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMailRoutingRuleDto'
      responses:
        '201':
          description: ''
      security:
      - jwt: []
      summary: Create a new mail routing rule
      tags:
      - Mail Routing Rules
  /api/mail-routing-rules/{id}:
    get:
      operationId: MailRoutingController_findById
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Get a mail routing rule by id
      tags:
      - Mail Routing Rules
    patch:
      operationId: MailRoutingController_update
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMailRoutingRuleDto'
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Update a mail routing rule
      tags:
      - Mail Routing Rules
    delete:
      operationId: MailRoutingController_delete
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Delete a mail routing rule
      tags:
      - Mail Routing Rules
  /api/mail-routing-rules/{id}/toggle:
    patch:
      operationId: MailRoutingController_toggle
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Toggle the active flag of a mail routing rule
      tags:
      - Mail Routing Rules
  /api/mail-routing-rules/test:
    post:
      operationId: MailRoutingController_testRules
      parameters:
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      responses:
        '201':
          description: ''
      security:
      - jwt: []
      summary: Dry-run a synthetic email against active routing rules
      tags:
      - Mail Routing Rules
      x-required-scope:
      - rules:read
components:
  schemas:
    CreateMailRoutingRuleDto:
      type: object
      properties:
        name:
          type: string
        accountId:
          type: string
        toEmail:
          type: string
        fromEmail:
          type: string
        fromDomain:
          type: string
        subjectPattern:
          type: string
        keywords:
          type: array
          items:
            type: string
        keywordMode:
          type: string
        searchScope:
          type: array
          items:
            type: string
        matchType:
          type: string
        aiCriteria:
          type: string
        aiModel:
          type: string
        action:
          type: string
        targetFolder:
          type: string
        forwardTo:
          type: string
        markRead:
          type: boolean
        stopProcessing:
          type: boolean
        sortOrder:
          type: number
      required:
      - name
    UpdateMailRoutingRuleDto:
      type: object
      properties:
        name:
          type: string
        isActive:
          type: boolean
        accountId:
          type:
          - string
          - 'null'
        toEmail:
          type:
          - string
          - 'null'
        fromEmail:
          type:
          - string
          - 'null'
        fromDomain:
          type:
          - string
          - 'null'
        subjectPattern:
          type:
          - string
          - 'null'
        keywords:
          type: array
          items:
            type: string
        keywordMode:
          type: string
        searchScope:
          type: array
          items:
            type: string
        matchType:
          type: string
        aiCriteria:
          type:
          - string
          - 'null'
        aiModel:
          type:
          - string
          - 'null'
        action:
          type: string
        targetFolder:
          type: string
        forwardTo:
          type:
          - string
          - 'null'
        markRead:
          type: boolean
        stopProcessing:
          type: boolean
        sortOrder:
          type: number
  securitySchemes:
    jwt:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: JWT access token from /auth/login (Bearer <token>)
    tenant-api-key:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Tenant API key (Bearer ldm_*) for MCP/A2A clients. Issued via CRM Settings → API Keys.
    rpa-service:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Dedicated RPA service key. No tenant API-key or query-key authentication.