Live Direct Marketing

Live Direct Marketing Inbound Rules API

The Inbound Rules API from Live Direct Marketing — 7 operation(s) for inbound rules.

GitHub OpenAPI

Operations 10

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/inbound-rules List inbound rules · List all inbound rules #
Ask an LLM
“Which inbound email rules are set up to turn messages into leads?”
“Can I see all my inbound routing rules?”
Tell an agent
List all my inbound rules.
Show every inbound email routing rule.
POST /api/inbound-rules Create an inbound lead rule · Create a new inbound rule #
Ask an LLM
“How do I automatically create a lead when an email matching certain keywords arrives?”
“Can an inbound rule use AI criteria to decide whether to make a lead?”
Tell an agent
Create inbound rule {name} that adds leads to pipeline {pipeline}.
Make rule {name} turning emails from {domain} into leads in pipeline {pipeline}.
GET /api/inbound-rules/events List inbound-rule automation events · List recent inbound-rule automation events #
Ask an LLM
“What have my inbound rules done recently?”
“Can I filter automation events by date range or event type?”
Tell an agent
List inbound-rule events of type {type} from {from} to {to}, page {page} of {size}.
Search automation events for {search} from source {source}, page {page}, {size} rows, {from} to {to}, type {type}.
GET /api/inbound-rules/{id} Get an inbound rule · Get an inbound rule by id #
Ask an LLM
“How is a specific inbound rule configured?”
“Can I look up one inbound rule's match conditions?”
Tell an agent
Show inbound rule {id}.
Get the conditions of inbound rule {id}.
PATCH /api/inbound-rules/{id} Update an inbound rule · Update an inbound rule #
Ask an LLM
“Can I change the keywords or target stage of an existing inbound rule?”
“How do I edit an inbound rule's lead priority?”
Tell an agent
Change inbound rule {id}'s keywords to {keywords}.
Send leads from rule {id} to stage {stage}.
DELETE /api/inbound-rules/{id} Delete an inbound rule · Delete an inbound rule #
Ask an LLM
“Can I delete an inbound rule I no longer use?”
“Is removing an inbound rule permanent?”
Tell an agent destructive · confirm first
Delete inbound rule {id}.
Remove routing rule {id}.
PATCH /api/inbound-rules/reorder Reorder inbound rules · Reorder inbound rules (sortOrder) #
Ask an LLM
“Can I change which inbound rule is evaluated first?”
“How do I set the priority order of inbound rules?”
Tell an agent
Reorder inbound rules as {ids}.
Set inbound rule sort order to {items}.
PATCH /api/inbound-rules/{id}/toggle Turn an inbound rule on or off · Toggle the active flag of an inbound rule #
Ask an LLM
“Can I temporarily disable an inbound rule without deleting it?”
“How do I switch an inbound rule back on?”
Tell an agent
Toggle inbound rule {id} on or off.
Disable inbound rule {id} for now.
POST /api/inbound-rules/test Dry-run a message against inbound rules · Dry-run synthetic inbound message against active rules #
Ask an LLM
“Can I test which inbound rule would catch a message without creating a lead?”
“Is there a dry run for my active inbound rules?”
Tell an agent
Dry-run a sample inbound message against my active rules.
Test which inbound rule a synthetic email would match.
POST /api/inbound-rules/reapply Re-apply keyword routing to intake leads · Re-apply keyword routing to leads in the intake stage #
Ask an LLM
“Can I rerun keyword routing on leads still sitting in the intake stage?”
“After changing rules, how do I re-route existing leads?”
Tell an agent
Re-apply keyword routing to leads in stage {stage} of pipeline {pipeline}.
Re-route intake leads from stage {stage} in pipeline {pipeline}.

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-inbound-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-inbound-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-inbound-rules-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: LDM v3 Inbound 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: Inbound Rules
paths:
  /api/inbound-rules:
    get:
      operationId: InboundRulesController_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 inbound rules
      tags:
      - Inbound Rules
    post:
      operationId: InboundRulesController_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/CreateInboundRuleDto'
      responses:
        '201':
          description: ''
      security:
      - jwt: []
      summary: Create a new inbound rule
      tags:
      - Inbound Rules
  /api/inbound-rules/events:
    get:
      operationId: InboundRulesController_listAutomationEvents
      parameters:
      - name: page
        required: true
        in: query
        schema:
          type: string
      - name: pageSize
        required: true
        in: query
        schema:
          type: string
      - name: search
        required: true
        in: query
        schema:
          type: string
      - name: dateFrom
        required: true
        in: query
        schema:
          type: string
      - name: dateTo
        required: true
        in: query
        schema:
          type: string
      - name: eventType
        required: true
        in: query
        schema:
          type: string
      - name: source
        required: true
        in: query
        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: List recent inbound-rule automation events
      tags:
      - Inbound Rules
      x-required-scope:
      - rules:read
  /api/inbound-rules/{id}:
    get:
      operationId: InboundRulesController_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 an inbound rule by id
      tags:
      - Inbound Rules
    patch:
      operationId: InboundRulesController_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/UpdateInboundRuleDto'
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Update an inbound rule
      tags:
      - Inbound Rules
    delete:
      operationId: InboundRulesController_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 an inbound rule
      tags:
      - Inbound Rules
  /api/inbound-rules/reorder:
    patch:
      operationId: InboundRulesController_reorder
      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/ReorderInboundRulesDto'
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Reorder inbound rules (sortOrder)
      tags:
      - Inbound Rules
      x-required-scope:
      - rules:write
  /api/inbound-rules/{id}/toggle:
    patch:
      operationId: InboundRulesController_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 an inbound rule
      tags:
      - Inbound Rules
  /api/inbound-rules/test:
    post:
      operationId: InboundRulesController_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 synthetic inbound message against active rules
      tags:
      - Inbound Rules
      x-required-scope:
      - rules:read
  /api/inbound-rules/reapply:
    post:
      operationId: InboundRulesController_reapply
      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/ReapplyInboundRulesDto'
      responses:
        '201':
          description: ''
      security:
      - jwt: []
      summary: Re-apply keyword routing to leads in the intake stage
      tags:
      - Inbound Rules
      x-required-scope:
      - rules:write
components:
  schemas:
    CreateInboundRuleDto:
      type: object
      properties:
        name:
          type: string
        accountId:
          type: string
        toEmail:
          type: string
        fromEmail:
          type: string
        fromDomain:
          type: string
        keywords:
          type: array
          items:
            type: string
        keywordMode:
          type: string
        subjectPattern:
          type: string
        searchScope:
          type: array
          items:
            type: string
        matchType:
          type: string
        aiCriteria:
          type: string
        aiModel:
          type: string
        pipelineId:
          type: string
        stageId:
          type: string
        leadTitle:
          type: string
        leadSource:
          type: string
        leadPriority:
          type: object
        linkContact:
          type: boolean
        linkDialog:
          type: boolean
        createWithoutContact:
          type: boolean
        sortOrder:
          type: number
      required:
      - name
      - pipelineId
    ReorderInboundRulesDto:
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/ReorderItemDto'
    UpdateInboundRuleDto:
      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'
        keywords:
          type: array
          items:
            type: string
        keywordMode:
          type: string
        subjectPattern:
          type:
          - string
          - 'null'
        searchScope:
          type: array
          items:
            type: string
        matchType:
          type: string
        aiCriteria:
          type:
          - string
          - 'null'
        aiModel:
          type:
          - string
          - 'null'
        pipelineId:
          type: string
        stageId:
          type:
          - string
          - 'null'
        leadTitle:
          type:
          - string
          - 'null'
        leadSource:
          type:
          - string
          - 'null'
        leadPriority:
          type: object
        linkContact:
          type: boolean
        linkDialog:
          type: boolean
        createWithoutContact:
          type: boolean
        sortOrder:
          type: number
    ReorderItemDto:
      type: object
      properties:
        id:
          type: string
        sortOrder:
          type: number
      required:
      - id
      - sortOrder
    ReapplyInboundRulesDto:
      type: object
      properties:
        pipelineId:
          type: string
        fromStageId:
          type: string
      required:
      - pipelineId
      - fromStageId
  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.