Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Admin API

140 actions 140 updates phrasing extends openapi/live-direct-marketing-online-admin-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Live Direct Marketing's API. It is a proposal applied on top of the contract, not a document Live Direct Marketing publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 140 · first 16 shown; the file carries all of them

$.info
$.paths['/api/admin/tests/{token}/reanalyze'].post
$.paths['/api/admin/feedback'].get
$.paths['/api/admin/feedback/stats'].get
$.paths['/api/admin/beta-signups'].get
$.paths['/api/admin/beta-signups/stats'].get
$.paths['/api/admin/screenshot-orders/stats'].get
$.paths['/api/admin/recheck-jobs'].get
$.paths['/api/admin/recheck-jobs/stats'].get
$.paths['/api/admin/stats'].get
$.paths['/api/admin/slack/installations'].get
$.paths['/api/admin/deliverability/config'].get
$.paths['/api/admin/deliverability/config'].put
$.paths['/api/admin/seeds'].get
$.paths['/api/admin/seeds'].post
$.paths['/api/admin/seeds/{id}/archive'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Admin API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-admin-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 139
- target: $.paths['/api/admin/tests/{token}/reanalyze'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-run analysis of an inbox placement test
      effect: write
      questions:
      - Can I recompute the analysis of a test without losing its placement and delivery timestamps?
      - What happens to the original received copy when an admin reanalyzes a test?
      instructions:
      - text: Reanalyze inbox test {token} from its original received copy.
        slots:
          token: path.token
      - text: Recompute the analysis for test {token} but keep its placement results.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/feedback'].get
  update:
    x-apievangelist-phrasing:
      intent: List user feedback submissions
      effect: read
      questions:
      - Where can an admin read the feedback users have submitted?
      - Can I page through feedback entries with limit and offset?
      instructions:
      - text: Show the latest {limit} feedback submissions.
        slots:
          limit: query.limit
      - text: List feedback entries starting at offset {offset}.
        slots:
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/feedback/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get feedback statistics
      effect: read
      questions:
      - How much user feedback has come in overall?
      - What do the aggregate feedback stats look like?
      instructions:
      - text: Give me the summary statistics for user feedback.
      - text: Report totals across all feedback submissions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/beta-signups'].get
  update:
    x-apievangelist-phrasing:
      intent: List beta program signups
      effect: read
      questions:
      - Who has signed up for the beta?
      - Can I filter beta signups by platform?
      instructions:
      - text: List beta signups for the {platform} platform.
        slots:
          platform: query.platform
      - text: Show {limit} beta signups starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/beta-signups/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get beta signup statistics
      effect: read
      questions:
      - How many people have joined the beta so far?
      - What is the breakdown of beta signup numbers?
      instructions:
      - text: Summarize beta signup counts.
      - text: Pull the aggregate beta signups stats.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/screenshot-orders/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get screenshot order statistics
      effect: read
      questions:
      - How many screenshot orders were placed recently?
      - Can I see screenshot order stats over a chosen number of days?
      instructions:
      - text: Show screenshot order stats for the last {days} days.
        slots:
          days: query.days
      - text: Report screenshot order volume across the platform.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/recheck-jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List recheck jobs
      effect: read
      questions:
      - Which recheck jobs are queued or have failed?
      - Can I filter recheck jobs by status?
      instructions:
      - text: List recheck jobs with status {status}.
        slots:
          status: query.status
      - text: Show {limit} recheck jobs from offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/recheck-jobs/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get recheck job statistics
      effect: read
      questions:
      - How are recheck jobs performing in aggregate?
      - What totals exist for recheck jobs by outcome?
      instructions:
      - text: Summarize recheck job counts.
      - text: Give me the recheck jobs statistics overview.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get platform admin statistics
      effect: read
      questions:
      - What are the headline admin numbers for the whole platform?
      - Is there a single endpoint for overall admin dashboard stats?
      instructions:
      - text: Show the overall admin dashboard statistics.
      - text: Report platform-wide admin totals.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/slack/installations'].get
  update:
    x-apievangelist-phrasing:
      intent: List Slack workspace installations
      effect: read
      questions:
      - Which Slack workspaces have installed the app?
      - Can I see every Slack installation as an admin?
      instructions:
      - text: List all Slack workspaces where the app is installed.
      - text: Show the Slack installations on the platform.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/deliverability/config'].get
  update:
    x-apievangelist-phrasing:
      intent: View deliverability control settings
      effect: read
      questions:
      - What is the current deliverability control configuration?
      - Where do I see the deliverability control settings in effect?
      instructions:
      - text: Show the current deliverability control config.
      - text: Read back the deliverability settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/deliverability/config'].put
  update:
    x-apievangelist-phrasing:
      intent: Change deliverability control settings
      effect: write
      questions:
      - Can I change the deliverability control configuration?
      - Is an admin actor recorded when deliverability settings are updated?
      instructions:
      - text: Update the deliverability control config as admin {actor}.
        slots:
          actor: header.x-admin-actor
      - text: Save new deliverability settings, attributing the change to {actor}.
        slots:
          actor: header.x-admin-actor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/seeds'].get
  update:
    x-apievangelist-phrasing:
      intent: List seed mailbox accounts
      effect: read
      questions:
      - Which seed mailboxes are used for inbox placement tests?
      - Can I filter seed accounts by mailbox provider or health?
      instructions:
      - text: List seed accounts on provider {provider}.
        slots:
          provider: query.provider
      - text: Show seeds with status {status} and health {health}.
        slots:
          status: query.status
          health: query.health
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/seeds'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a single seed account
      effect: write
      questions:
      - How do I add one new seed mailbox to the placement panel?
      - Can I register an individual seed account by hand?
      instructions:
      - text: Add a new seed mailbox account.
      - text: Register one more seed account for placement testing.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/seeds/{id}/archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive a seed account
      effect: write
      questions:
      - Can I take a seed mailbox out of rotation without deleting it?
      - What does archiving a seed account do?
      instructions:
      - text: Archive seed {id} as admin {actor}.
        slots:
          id: path.id
          actor: header.x-admin-actor
      - text: Retire seed account {id} from testing.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/seeds/{id}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore an archived seed account
      effect: write
      questions:
      - Can an archived seed mailbox be brought back into use?
      - How do I un-archive a seed account?
      instructions:
      - text: Restore archived seed {id} as admin {actor}.
        slots:
          id: path.id
          actor: header.x-admin-actor
      - text: Put seed account {id} back into rotation.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/audit-log'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse the admin audit log
      effect: read
      questions:
      - Who changed what in the admin console?
      - Can I filter admin audit entries by entity type or action?
      instructions:
      - text: Show admin audit log entries for {entityType} {entityId}.
        slots:
          entityType: query.entityType
          entityId: query.entityId
      - text: List the last {limit} audit entries with action {action}.
        slots:
          limit: query.limit
          action: query.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/seed-health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check seed account health
      effect: read
      questions:
      - Are any seed mailboxes unhealthy right now?
      - What is the health summary across all seeds?
      instructions:
      - text: Show the health overview of all seed accounts.
      - text: Report which seed mailboxes look broken.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/seeds/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk-upload custom seed accounts
      effect: write
      questions:
      - Can I upload many custom seed accounts at once?
      - Is there a bulk import for seed mailboxes?
      instructions:
      - text: Bulk-upload this batch of custom seed accounts.
      - text: Add a list of seed mailboxes in one request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/seeds/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a seed account
      effect: write
      questions:
      - Can I change the details of an existing seed mailbox?
      - What fields on a seed account can be patched?
      instructions:
      - text: Update seed account {id} with the new settings.
        slots:
          id: path.id
      - text: Patch the configuration of seed {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/seeds/sync-ldm'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync seeds from LDM
      effect: write
      questions:
      - Can I sync the seed list from the LDM platform?
      - How are seed accounts kept in step with LDM?
      instructions:
      - text: Sync seed accounts from LDM now.
      - text: Run the LDM seed synchronization.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/ldm/control-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List LDM control accounts
      effect: read
      questions:
      - Which LDM control accounts are available?
      - What control mailboxes exist on the LDM side?
      instructions:
      - text: List the LDM control accounts.
      - text: Show me every control account available from LDM.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/seeds/import-from-ldm'].post
  update:
    x-apievangelist-phrasing:
      intent: Import seeds from LDM
      effect: write
      questions:
      - Can I import LDM control accounts as new seeds?
      - Is there a one-time import of seeds from LDM?
      instructions:
      - text: Import seed accounts from LDM.
      - text: Pull LDM control accounts in as seeds.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/seeds/import-oauth-combo'].post
  update:
    x-apievangelist-phrasing:
      intent: Import Outlook combo seeds via OAuth
      effect: write
      questions:
      - Can I import Outlook combo seeds that authenticate with IMAP XOAUTH2?
      - Which import handles public-client Outlook seed accounts?
      instructions:
      - text: Import Outlook combo seeds using IMAP XOAUTH2.
      - text: Load public-client Outlook seed accounts from a combo list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/seeds/{id}/probe'].post
  update:
    x-apievangelist-phrasing:
      intent: Probe a seed account connection
      effect: write
      questions:
      - Can I test whether a single seed mailbox still connects?
      - How do I check one seed's login works?
      instructions:
      - text: Probe seed {id} to confirm it connects.
        slots:
          id: path.id
      - text: Run a connectivity check against seed account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List mailbox providers
      effect: read
      questions:
      - Which mailbox providers are configured for placement testing?
      - What providers does the admin panel know about?
      instructions:
      - text: List all configured mailbox providers.
      - text: Show the provider catalog in admin.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/providers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a mailbox provider
      effect: write
      questions:
      - Can I add a new mailbox provider to the catalog?
      - How is a new provider registered for testing?
      instructions:
      - text: Create a new mailbox provider entry.
      - text: Register an additional provider in the catalog.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/providers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a mailbox provider
      effect: read
      questions:
      - What settings does a specific mailbox provider have?
      - Can I look up one provider by id?
      instructions:
      - text: Show mailbox provider {id}.
        slots:
          id: path.id
      - text: Fetch the details of provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/providers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a mailbox provider
      effect: destructive
      questions:
      - Can I remove a mailbox provider from the catalog?
      - What happens when a provider is deleted?
      instructions:
      - text: Delete mailbox provider {id}.
        slots:
          id: path.id
      - text: Remove provider {id} from the catalog.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/providers/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a mailbox provider
      effect: write
      questions:
      - Can I edit an existing mailbox provider's settings?
      - Which provider fields can be patched?
      instructions:
      - text: Update mailbox provider {id}.
        slots:
          id: path.id
      - text: Patch the configuration of provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/providers/{id}/delivery-blocks'].get
  update:
    x-apievangelist-phrasing:
      intent: List a provider's delivery blocks
      effect: read
      questions:
      - Which delivery blocks are set on a mailbox provider?
      - Is delivery to a given provider currently blocked?
      instructions:
      - text: List delivery blocks for provider {id}.
        slots:
          id: path.id
      - text: Show what is blocking delivery to provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/providers/{id}/delivery-blocks'].post
  update:
    x-apievangelist-phrasing:
      intent: Block delivery to a provider
      effect: write
      questions:
      - Can I add a delivery block to a mailbox provider?
      - How do I stop sends going to one provider?
      instructions:
      - text: Add a delivery block to provider {id}.
        slots:
          id: path.id
      - text: Block outgoing delivery to mailbox provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/providers/{id}/delivery-blocks/{blockId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a delivery block
      effect: destructive
      questions:
      - Can I lift a delivery block from a provider?
      - What removes a single block from a provider's delivery blocks?
      instructions:
      - text: Remove delivery block {blockId} from provider {id}.
        slots:
          blockId: path.blockId
          id: path.id
      - text: Lift block {blockId} on mailbox provider {id}.
        slots:
          blockId: path.blockId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/seeds/{id}/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get statistics for one seed
      effect: read
      questions:
      - How has a particular seed mailbox performed?
      - Can I see only recent results for one seed account?
      instructions:
      - text: Show stats for seed {id}.
        slots:
          id: path.id
      - text: Give me the recent {recent} results for seed account {id}.
        slots:
          recent: query.recent
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/providers/{id}/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get statistics for a mailbox provider
      effect: read
      questions:
      - How is a given mailbox provider performing in tests?
      - What placement stats exist per provider?
      instructions:
      - text: Show the stats for provider {id}.
        slots:
          id: path.id
      - text: Report test performance for mailbox provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/seeds/health-check'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a seed health check
      effect: write
      questions:
      - Can I trigger a fresh health check across all seeds?
      - Does the seed health check cover inactive seeds too?
      instructions:
      - text: Run a seed health check now.
      - text: Run the seed health check with inactive seeds included set to {includeInactive}.
        slots:
          includeInactive: query.includeInactive
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/cleanup/imap'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger IMAP mailbox cleanup
      effect: destructive
      questions:
      - Can I force the IMAP cleanup job to run right away?
      - What clears old messages out of seed inboxes?
      instructions:
      - text: Trigger the IMAP cleanup now.
      - text: Run the seed inbox IMAP cleanup immediately.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/bounces/process-now'].post
  update:
    x-apievangelist-phrasing:
      intent: Process bounces immediately
      effect: write
      questions:
      - Can I process pending bounces without waiting for the schedule?
      - How is bounce processing kicked off manually?
      instructions:
      - text: Process bounces now.
      - text: Run the bounce processor immediately.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/tests'].get
  update:
    x-apievangelist-phrasing:
      intent: List inbox placement tests
      effect: read
      questions:
      - Which inbox placement tests have run across the platform?
      - Can I search tests by text and filter by status?
      instructions:
      - text: List tests with status {status}.
        slots:
          status: query.status
      - text: Search inbox tests for {q}.
        slots:
          q: query.q
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/tests/{token}/trace'].get
  update:
    x-apievangelist-phrasing:
      intent: Trace a test end to end
      effect: read
      questions:
      - Why did a specific inbox test behave oddly?
      - Can I see everything known about one test token, including per-seed results?
      instructions:
      - text: Trace test {token} end to end.
        slots:
          token: path.token
      - text: Show the debugging trace with per-seed placement for test {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/queues'].get
  update:
    x-apievangelist-phrasing:
      intent: View queue overview
      effect: read
      questions:
      - What do the background job queues look like right now?
      - Which queues have a backlog?
      instructions:
      - text: Show an overview of all job queues.
      - text: Report the depth of every background queue.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/visitors'].get
  update:
    x-apievangelist-phrasing:
      intent: Analyze site visitors
      effect: read
      questions:
      - Who has been visiting the site in the last few hours?
      - Can I filter visitors by agent, source or destination?
      instructions:
      - text: Show visitors from the last {hours} hours.
        slots:
          hours: query.hours
      - text: List visitors from source {source} matching {search}.
        slots:
          source: query.source
          search: query.search
      - text: Show visitors using agent {agent} on page {page}.
        slots:
          agent: query.agent
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/transport-health'].get
  update:
    x-apievangelist-phrasing:
      intent: Probe public transport endpoints
      effect: read
      questions:
      - Are the public transport endpoints up and how fast do they answer?
      - Can I measure server-side latency of each transport without TLS overhead?
      instructions:
      - text: Probe every public transport endpoint and report latency.
      - text: Check transport health end to end.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/protocol-stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get AI-agent transport traffic stats
      effect: read
      questions:
      - How much traffic are the MCP and A2A transports getting?
      - Are AI agents actually using the agent protocols?
      instructions:
      - text: Show {protocol} request traffic for the last {hours} hours.
        slots:
          protocol: query.protocol
          hours: query.hours
      - text: Report MCP and A2A protocol usage.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Read server logs
      effect: read
      questions:
      - Can I read the application logs from the admin panel?
      - Is it possible to filter logs by level or search text?
      instructions:
      - text: Show the last {lines} lines of the {stream} log.
        slots:
          lines: query.lines
          stream: query.stream
      - text: Find {level} log lines containing {q}.
        slots:
          level: query.level
          q: query.q
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/operations-health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check operations health
      effect: read
      questions:
      - Is the platform operationally healthy?
      - What is the overall operations health status?
      instructions:
      - text: Show the operations health status.
      - text: Report on overall operational health.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/api-keys/scopes/structured'].get
  update:
    x-apievangelist-phrasing:
      intent: List API key scope catalog
      effect: read
      questions:
      - What scopes can an API key be granted?
      - Which scope presets exist and which scopes are flagged as dangerous?
      instructions:
      - text: List the structured API key scope catalog.
      - text: Show scope presets like readOnly and fullAuto.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/api-keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List all API keys
      effect: read
      questions:
      - Which API keys exist across the platform?
      - Can an admin see every issued API key?
      instructions:
      - text: List all API keys.
      - text: Show every API key issued on the platform.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/api-keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API key
      effect: write
      questions:
      - Can I issue a new API key with daily and monthly limits?
      - What scopes and tier can a new key be created with?
      instructions:
      - text: Create an API key named {name}.
        slots:
          name: requestBody.name
      - text: Create key {name} on tier {tier} with a daily limit of {dailyLimit}.
        slots:
          name: requestBody.name
          tier: requestBody.tier
          dailyLimit: requestBody.dailyLimit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/api-keys/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an API key
      effect: destructive
      questions:
      - Can I revoke an API key that leaked?
      - Is revoking a key a hard delete or a soft delete?
      instructions:
      - text: Revoke API key {id}.
        slots:
          id: path.id
      - text: Disable key {id} so it can no longer be used.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/api-keys/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an API key
      effect: write
      questions:
      - Can I raise the monthly limit on an existing API key?
      - Is it possible to deactivate a key without revoking it?
      instructions:
      - text: Set the monthly limit of key {id} to {monthlyLimit}.
        slots:
          id: path.id
          monthlyLimit: requestBody.monthlyLimit
      - text: Set API key {id} active to {active}.
        slots:
          id: path.id
          active: requestBody.active
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/api-keys/{id}/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get API key usage
      effect: read
      questions:
      - How much has a particular API key been used?
      - Can I see key usage events within a date range?
      instructions:
      - text: Show usage for API key {id}.
        slots:
          id: path.id
      - text: Get usage events for key {id} from {from} to {to}.
        slots:
          id: path.id
          from: query.from
          to: query.to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/dmarc/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize DMARC results
      effect: read
      questions:
      - How are our domains doing on DMARC overall?
      - What is the DMARC pass rate over the last few days?
      instructions:
      - text: Summarize DMARC results for the last {days} days.
        slots:
          days: query.days
      - text: Give me the DMARC summary.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/dmarc/sources'].get
  update:
    x-apievangelist-phrasing:
      intent: List DMARC sending sources
      effect: read
      questions:
      - Which IPs and sources are sending mail as our domains?
      - Can I see the top DMARC sources over a period?
      instructions:
      - text: List the top {limit} DMARC sending sources.
        slots:
          limit: query.limit
      - text: Show DMARC sources seen in the last {days} days.
        slots:
          days: query.days
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/dmarc/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List DMARC aggregate reports
      effect: read
      questions:
      - Which DMARC aggregate reports have we received?
      - Can I filter DMARC reports by domain?
      instructions:
      - text: List DMARC reports for domain {domain}.
        slots:
          domain: query.domain
      - text: Show the last {limit} DMARC reports from the past {days} days.
        slots:
          limit: query.limit
          days: query.days
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/dmarc/reports/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a DMARC report
      effect: read
      questions:
      - What is inside a specific DMARC report?
      - Can I open one DMARC report by id?
      instructions:
      - text: Open DMARC report {id}.
        slots:
          id: path.id
      - text: Show the records in DMARC report {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/dmarc/poll'].post
  update:
    x-apievangelist-phrasing:
      intent: Poll for new DMARC reports
      effect: write
      questions:
      - Can I fetch new DMARC reports immediately?
      - How do I trigger a DMARC mailbox poll?
      instructions:
      - text: Poll for new DMARC reports now.
      - text: Check the DMARC inbox for fresh reports.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/account-transfers/plan'].post
  update:
    x-apievangelist-phrasing:
      intent: Dry-run an account transfer
      effect: read
      questions:
      - Can I preview what moving accounts between tenant databases would do?
      - What does an account transfer dry-run return before anything changes?
      instructions:
      - text: Plan a transfer of {resources} from {sourceEmails} to {targetEmail}.
        slots:
          resources: requestBody.resources
          sourceEmails: requestBody.sourceEmails
          targetEmail: requestBody.targetEmail
      - text: Dry-run moving accounts {sourceEmails} into {targetEmail} for {resources}.
        slots:
          sourceEmails: requestBody.sourceEmails
          targetEmail: requestBody.targetEmail
          resources: requestBody.resources
      method: generated
      generated: '2026-10-01'


# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/live-direct-marketing-online/refs/heads/main/overlays/live-direct-marketing-online-admin-api-phrasing-overlay.yaml