Live Direct Marketing

Live Direct Marketing Stop List API

The Stop List API from Live Direct Marketing — 9 operation(s) for stop list.

GitHub OpenAPI

Operations 11

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/stop-lists List my stop list entries · List stop list entries (user scope) #
Ask an LLM
“Which emails and domains are on my workspace's do-not-contact list?”
“Can I search my own stop list by type?”
Tell an agent
List my stop list entries of type {type}, page {page} with {limit} per page.
Search my stop list for {search}.
POST /api/stop-lists Add an entry to my stop list · Add a stop list entry (user scope) #
Ask an LLM
“How do I stop emailing one particular address or domain?”
“Can I add a single do-not-contact entry for my workspace?”
Tell an agent
Add this address to my stop list.
Put one domain on my workspace do-not-contact list.
GET /api/stop-lists/stats Get my stop list statistics · Get stop list statistics (user scope) #
Ask an LLM
“How many entries are on my own stop list?”
“What's the breakdown of my do-not-contact list by type?”
Tell an agent
Show statistics for my stop list.
Count the entries in my workspace stop list.
POST /api/stop-lists/bulk Bulk-add entries to my stop list · Bulk-add stop list entries (user scope) #
Ask an LLM
“Can I upload many unsubscribed addresses to my stop list at once?”
“Is there a bulk way to block a whole batch of emails for my workspace?”
Tell an agent
Bulk-add these addresses to my stop list.
Block this whole batch of emails in my workspace stop list.
DELETE /api/stop-lists/{id} Remove an entry from my stop list · Remove a stop list entry (user scope) #
Ask an LLM
“Can I take someone off my do-not-contact list?”
“What if I added an address to my stop list by mistake?”
Tell an agent destructive · confirm first
Remove stop list entry {id}.
Unblock entry {id} from my workspace stop list.
POST /api/stop-lists/check Check emails against the stop list · Check a batch of emails against the stop list #
Ask an LLM
“Are any of these addresses blocked before I send a campaign?”
“Can I check a batch of emails against the stop list in one call?”
Tell an agent
Check {emails} against the stop list.
Tell me which of {emails} are blocked from sending.
GET /api/stop-lists/global List platform-wide stop list entries · List global stop list entries (SUPER only) #
Ask an LLM
“As a super admin, which entries are on the global stop list for every tenant?”
“Can I search the platform-wide stop list?”
Tell an agent
List global stop list entries of type {type}, page {page}, {limit} per page.
Search the global stop list for {search}.
POST /api/stop-lists/global Add an entry to the global stop list · Add a global stop list entry (SUPER only) #
Ask an LLM
“How does a super admin block an address for all tenants?”
“Can one domain be added to the platform-wide stop list?”
Tell an agent
Add this address to the global stop list for every tenant.
Block one domain platform-wide.
GET /api/stop-lists/global/stats Get global stop list statistics · Get global stop list statistics (SUPER only) #
Ask an LLM
“How big is the platform-wide stop list?”
“What are the super-admin statistics for the global do-not-contact list?”
Tell an agent
Show global stop list statistics.
Count entries on the platform-wide stop list.
POST /api/stop-lists/global/bulk Bulk-add entries to the global stop list · Bulk-add global stop list entries (SUPER only) #
Ask an LLM
“Can a super admin block a large list of addresses across all tenants at once?”
“Is there a bulk import for the global stop list?”
Tell an agent
Bulk-add these entries to the global stop list.
Block this batch of domains for all tenants.
DELETE /api/stop-lists/global/{id} Remove an entry from the global stop list · Remove a global stop list entry (SUPER only) #
Ask an LLM
“Can a super admin unblock an address on the platform-wide stop list?”
“What if a domain was added to the global stop list by mistake?”
Tell an agent destructive · confirm first
Remove global stop list entry {id}.
Unblock entry {id} for all tenants.

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-stop-list-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-stop-list-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-stop-list-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: LDM v3 Stop List 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: Stop List
paths:
  /api/stop-lists:
    get:
      operationId: StopListController_list
      parameters:
      - name: page
        required: true
        in: query
        schema:
          type: string
      - name: limit
        required: true
        in: query
        schema:
          type: string
      - name: type
        required: true
        in: query
        schema:
          type: string
      - name: search
        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 stop list entries (user scope)
      tags:
      - Stop List
    post:
      operationId: StopListController_add
      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: Add a stop list entry (user scope)
      tags:
      - Stop List
  /api/stop-lists/stats:
    get:
      operationId: StopListController_stats
      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 stop list statistics (user scope)
      tags:
      - Stop List
      x-required-scope:
      - stoplist:read
  /api/stop-lists/bulk:
    post:
      operationId: StopListController_addBulk
      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: Bulk-add stop list entries (user scope)
      tags:
      - Stop List
      x-required-scope:
      - stoplist:write
  /api/stop-lists/{id}:
    delete:
      operationId: StopListController_remove
      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: Remove a stop list entry (user scope)
      tags:
      - Stop List
  /api/stop-lists/check:
    post:
      operationId: StopListController_check
      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/CheckEmailsDto'
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Check a batch of emails against the stop list
      tags:
      - Stop List
      x-required-scope:
      - stoplist:read
  /api/stop-lists/global:
    get:
      operationId: StopListController_globalList
      parameters:
      - name: page
        required: true
        in: query
        schema:
          type: string
      - name: limit
        required: true
        in: query
        schema:
          type: string
      - name: type
        required: true
        in: query
        schema:
          type: string
      - name: search
        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 global stop list entries (SUPER only)
      tags:
      - Stop List
      x-required-scope:
      - stoplist:read
    post:
      operationId: StopListController_globalAdd
      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: Add a global stop list entry (SUPER only)
      tags:
      - Stop List
      x-required-scope:
      - stoplist:write
  /api/stop-lists/global/stats:
    get:
      operationId: StopListController_globalStats
      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 global stop list statistics (SUPER only)
      tags:
      - Stop List
      x-required-scope:
      - stoplist:read
  /api/stop-lists/global/bulk:
    post:
      operationId: StopListController_globalAddBulk
      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: Bulk-add global stop list entries (SUPER only)
      tags:
      - Stop List
      x-required-scope:
      - stoplist:write
  /api/stop-lists/global/{id}:
    delete:
      operationId: StopListController_globalRemove
      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: Remove a global stop list entry (SUPER only)
      tags:
      - Stop List
components:
  schemas:
    CheckEmailsDto:
      type: object
      properties:
        emails:
          minItems: 1
          type: array
          items:
            type: string
      required:
      - emails
  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.