Live Direct Marketing

Live Direct Marketing Admin RPA API

The Admin RPA API from Live Direct Marketing — 11 operation(s) for admin rpa.

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/admin/rpa Get the RPA admin overview · RPA service keys (redacted), tenant opt-ins, queue readiness and legacy drain… #
Ask an LLM
“Which RPA service keys and tenant opt-ins are configured right now?”
“Is there a single view of RPA queue readiness and legacy drain inventory?”
Tell an agent
Show the RPA admin overview.
List RPA service keys with tenant opt-ins and queue readiness.
POST /api/admin/rpa/keys Create an RPA service key · Create a dedicated RPA service key #
Ask an LLM
“How do I issue a dedicated key for an RPA worker?”
“Can I name a new RPA service key when I create it?”
Tell an agent
Create an RPA service key named {name}.
Issue a new dedicated RPA key called {name}.
POST /api/admin/rpa/keys/{id}/rotate Rotate an RPA service key · Rotate a dedicated RPA key, invalidating the previous secret #
Ask an LLM
“Can I rotate an RPA key's secret if it may have leaked?”
“Does rotating an RPA key stop the old secret from working?”
Tell an agent destructive · confirm first
Rotate RPA key {id}.
Issue a new secret for RPA key {id} and invalidate the old one.
GET /api/admin/rpa/keys/{id}/reveal Reveal an RPA service key secret · Reveal an encrypted current RPA key for SUPER; legacy hash-only keys cannot be… #
Ask an LLM
“Can a super admin see the current secret of an RPA key again?”
“Why can't some older RPA keys be revealed?”
Tell an agent
Reveal the secret for RPA key {id}.
Show the current encrypted secret of RPA key {id}.
PUT /api/admin/rpa/keys/{id}/global-access Allow an RPA key to work for all tenants · Explicitly allow an RPA key to claim work for all active tenant users #
Ask an LLM
“Can one RPA key claim work on behalf of every active tenant user?”
“How do I turn off global access for an RPA key?”
Tell an agent
Set global access for RPA key {id} to {enabled}.
Let RPA key {id} claim work for all active tenant users.
POST /api/admin/rpa/keys/{id}/revoke Revoke an RPA service key · Revoke RPA service access immediately; started sends remain for reconciliation #
Ask an LLM
“How do I cut off an RPA worker's access immediately?”
“What happens to sends already started when an RPA key is revoked?”
Tell an agent destructive · confirm first
Revoke RPA key {id}.
Cut off RPA service access for key {id} right now.
POST /api/admin/rpa/keys/{id}/trace Toggle detailed tracing for an RPA key · Enable detailed heartbeat/poll trace for one hour, or disable it #
Ask an LLM
“Can I turn on detailed heartbeat and poll tracing for an RPA key while debugging?”
“How long does RPA key tracing stay on?”
Tell an agent
Set trace on RPA key {id} to {enabled}.
Enable one hour of heartbeat tracing for RPA key {id}.
PUT /api/admin/rpa/keys/{id}/grants Grant an RPA key to a tenant user · Explicit tenant and user opt-in for a service key #
Ask an LLM
“How do I opt a specific tenant and user into an RPA service key?”
“Can I withdraw a user's opt-in for an RPA key?”
Tell an agent
Grant RPA key {id} to user {userId} in tenant {tenantId}, enabled {enabled}.
Opt tenant {tenantId} user {userId} into RPA key {id} with enabled {enabled}.
GET /api/admin/rpa/logs Search correlated RPA logs · Correlated RPA history; allowlisted metadata only, bounded keyset pagination #
Ask an LLM
“Can I see the RPA log history for one tenant filtered by reason code?”
“What metadata shows up in the RPA admin logs?”
Tell an agent
Show RPA logs for tenant {tenantId} with reason code {reasonCode}.
Search RPA logs for task {taskId}, {limit} entries.
GET /api/admin/rpa/task-history Get cross-tenant RPA task history · Alias for bounded cross-tenant RPA task history #
Ask an LLM
“Is there a cross-tenant history of RPA tasks I can page through?”
“Can I look up the task history of one RPA task across tenants?”
Tell an agent
Show cross-tenant RPA task history for task {taskId}.
Page RPA task history for tenant {tenantId} after cursor {cursor}.
GET /api/admin/rpa/protocol Describe the RPA protocol rules · RPA protocol endpoints and retry/lease rules #
Ask an LLM
“What are the RPA protocol endpoints and lease rules?”
“How often should an RPA worker retry, and how long do leases last?”
Tell an agent
Show the RPA protocol endpoints and retry rules.
Describe the RPA lease and retry rules.

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-admin-rpa-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-admin-rpa-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-admin-rpa-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: LDM v3 Admin RPA 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: Admin RPA
paths:
  /api/admin/rpa:
    get:
      operationId: RpaAdminController_overview
      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: RPA service keys (redacted), tenant opt-ins, queue readiness and legacy drain…
      tags:
      - Admin RPA
  /api/admin/rpa/keys:
    post:
      operationId: RpaAdminController_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/RpaCreateKeyDto'
      responses:
        '201':
          description: ''
      security:
      - jwt: []
      summary: Create a dedicated RPA service key
      tags:
      - Admin RPA
  /api/admin/rpa/keys/{id}/rotate:
    post:
      operationId: RpaAdminController_rotate
      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:
        '201':
          description: ''
      security:
      - jwt: []
      summary: Rotate a dedicated RPA key, invalidating the previous secret
      tags:
      - Admin RPA
  /api/admin/rpa/keys/{id}/reveal:
    get:
      operationId: RpaAdminController_reveal
      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: Reveal an encrypted current RPA key for SUPER; legacy hash-only keys cannot be…
      tags:
      - Admin RPA
  /api/admin/rpa/keys/{id}/global-access:
    put:
      operationId: RpaAdminController_globalAccess
      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/RpaGlobalAccessDto'
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Explicitly allow an RPA key to claim work for all active tenant users
      tags:
      - Admin RPA
  /api/admin/rpa/keys/{id}/revoke:
    post:
      operationId: RpaAdminController_revoke
      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:
        '201':
          description: ''
      security:
      - jwt: []
      summary: Revoke RPA service access immediately; started sends remain for reconciliation
      tags:
      - Admin RPA
  /api/admin/rpa/keys/{id}/trace:
    post:
      operationId: RpaAdminController_trace
      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/RpaTraceDto'
      responses:
        '201':
          description: ''
      security:
      - jwt: []
      summary: Enable detailed heartbeat/poll trace for one hour, or disable it
      tags:
      - Admin RPA
  /api/admin/rpa/keys/{id}/grants:
    put:
      operationId: RpaAdminController_grant
      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/RpaGrantDto'
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Explicit tenant and user opt-in for a service key
      tags:
      - Admin RPA
  /api/admin/rpa/logs:
    get:
      operationId: RpaAdminController_logs
      parameters:
      - name: tenantId
        required: true
        in: query
        schema:
          type: string
      - name: taskId
        required: true
        in: query
        schema:
          type: string
      - name: reasonCode
        required: true
        in: query
        schema:
          type: string
      - name: limit
        required: true
        in: query
        schema:
          type: string
      - name: cursor
        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: Correlated RPA history; allowlisted metadata only, bounded keyset pagination
      tags:
      - Admin RPA
  /api/admin/rpa/task-history:
    get:
      operationId: RpaAdminController_taskHistory
      parameters:
      - name: tenantId
        required: true
        in: query
        schema:
          type: string
      - name: taskId
        required: true
        in: query
        schema:
          type: string
      - name: reasonCode
        required: true
        in: query
        schema:
          type: string
      - name: limit
        required: true
        in: query
        schema:
          type: string
      - name: cursor
        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: Alias for bounded cross-tenant RPA task history
      tags:
      - Admin RPA
  /api/admin/rpa/protocol:
    get:
      operationId: RpaAdminController_protocol
      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: RPA protocol endpoints and retry/lease rules
      tags:
      - Admin RPA
components:
  schemas:
    RpaTraceDto:
      type: object
      properties:
        enabled:
          type: boolean
      required:
      - enabled
    RpaCreateKeyDto:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 100
      required:
      - name
    RpaGlobalAccessDto:
      type: object
      properties:
        enabled:
          type: boolean
      required:
      - enabled
    RpaGrantDto:
      type: object
      properties:
        tenantId:
          type: string
          minLength: 1
          maxLength: 128
        userId:
          type: string
          minLength: 1
          maxLength: 128
        enabled:
          type: boolean
      required:
      - tenantId
      - userId
      - enabled
  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.