Live Direct Marketing

Live Direct Marketing Mail Agent API

The Mail Agent API from Live Direct Marketing — 7 operation(s) for mail agent.

GitHub OpenAPI

Operations 8

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-agent/status Check the mail agent connection · Get the mail agent connection status and stats #
Ask an LLM
“Is my mail agent connected and sending right now?”
“What sending stats has the mail agent reported?”
Tell an agent
Show the mail agent connection status and stats.
Check whether my mail agent is online.
GET /api/mail-agent/settings View mail agent settings · Get current mail agent settings #
Ask an LLM
“What are my current mail agent settings?”
“Is the mail agent enabled in my workspace?”
Tell an agent
Show my current mail agent settings.
Get the mail agent configuration.
POST /api/mail-agent/settings Turn the mail agent on or off · Toggle the mail agent enabled flag #
Ask an LLM
“How do I enable or disable the mail agent?”
“Can I pause the mail agent by switching it off?”
Tell an agent
Toggle the mail agent enabled flag.
Switch the mail agent off for now.
POST /api/mail-agent/token/regenerate Regenerate the mail agent token · Regenerate the mail agent auth token #
Ask an LLM
“Can I issue a new auth token for the mail agent?”
“What do I do if my mail agent token was exposed?”
Tell an agent destructive · confirm first
Regenerate the mail agent auth token.
Rotate my mail agent token.
POST /api/mail-agent/stats/reset Reset mail agent statistics · Reset mail agent statistics counters #
Ask an LLM
“Can I zero out the mail agent's sending counters?”
“How do I start the mail agent stats fresh?”
Tell an agent destructive · confirm first
Reset the mail agent statistics counters.
Clear my mail agent stats.
POST /api/mail-agent/disconnect Disconnect the mail agent · Disconnect the mail agent session #
Ask an LLM
“How do I disconnect the mail agent session from my account?”
“Can I force the connected mail agent offline?”
Tell an agent destructive · confirm first
Disconnect the mail agent session.
Kick my mail agent off its current connection.
GET /api/mail-agent/download/windows Download the Windows mail agent · Download the Windows mail agent bundle with token pre-configured #
Ask an LLM
“Where do I download the mail agent for Windows?”
“Does the Windows mail agent come with my token already configured?”
Tell an agent
Download the Windows mail agent bundle.
Get the Windows mail agent with my token pre-configured.
GET /api/mail-agent/qr Get the Android mail agent pairing QR · Get an SVG QR code for pairing the Android mail agent #
Ask an LLM
“How do I pair the Android mail agent with my account?”
“Can I get a QR code to connect my phone as a mail agent?”
Tell an agent
Get the QR code for pairing the Android mail agent.
Show the SVG pairing QR for my Android phone.

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-agent-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-agent-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-agent-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: LDM v3 Mail Agent 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 Agent
paths:
  /api/mail-agent/status:
    get:
      operationId: MailAgentController_getStatus
      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: Get the mail agent connection status and stats
      tags:
      - Mail Agent
      x-required-scope:
      - agent:read
  /api/mail-agent/settings:
    get:
      operationId: MailAgentController_getSettings
      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: Get current mail agent settings
      tags:
      - Mail Agent
      x-required-scope:
      - agent:read
    post:
      operationId: MailAgentController_toggleEnabled
      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: Toggle the mail agent enabled flag
      tags:
      - Mail Agent
      x-required-scope:
      - agent:write
  /api/mail-agent/token/regenerate:
    post:
      operationId: MailAgentController_regenerateToken
      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: Regenerate the mail agent auth token
      tags:
      - Mail Agent
      x-required-scope:
      - agent:write
  /api/mail-agent/stats/reset:
    post:
      operationId: MailAgentController_resetStats
      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: Reset mail agent statistics counters
      tags:
      - Mail Agent
      x-required-scope:
      - agent:write
  /api/mail-agent/disconnect:
    post:
      operationId: MailAgentController_disconnect
      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: Disconnect the mail agent session
      tags:
      - Mail Agent
      x-required-scope:
      - agent:write
  /api/mail-agent/download/windows:
    get:
      operationId: MailAgentController_downloadWindows
      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: Download the Windows mail agent bundle with token pre-configured
      tags:
      - Mail Agent
      x-required-scope:
      - agent:write
  /api/mail-agent/qr:
    get:
      operationId: MailAgentController_getQr
      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: Get an SVG QR code for pairing the Android mail agent
      tags:
      - Mail Agent
      x-required-scope:
      - agent:read
components:
  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.