Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Email Accounts…

4 actions 4 updates phrasing extends openapi/live-direct-marketing-online-email-accounts-deliverability-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 4

$.info

$.paths['/api/email-accounts/{id}/deliverability'].get

$.paths['/api/email-accounts/{id}/deliverability/probe'].post

$.paths['/api/email-accounts/{id}/deliverability/block-rules/{provider}'].delete

OpenAPI Overlay

# 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 Email Accounts…
  version: 1.0.0
extends: openapi/live-direct-marketing-online-email-accounts-deliverability-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: 3
- target: $.paths['/api/email-accounts/{id}/deliverability'].get
  update:
    x-apievangelist-phrasing:
      intent: View a mailbox's deliverability snapshot
      effect: read
      questions:
      - Is my sending mailbox landing in the inbox at each mail provider?
      - Which mail providers are blocking one of my email accounts?
      instructions:
      - text: Show the deliverability snapshot for email account {id}.
        slots:
          id: path.id
      - text: Get baseline, creative and blocked results per provider for mailbox {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/deliverability/probe'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a deliverability probe on a mailbox
      effect: write
      questions:
      - Can I test a mailbox's deliverability right now instead of waiting?
      - How do I trigger a fresh inbox placement probe for one account?
      instructions:
      - text: Probe deliverability now for email account {id}.
        slots:
          id: path.id
      - text: Run a fresh placement test on mailbox {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/email-accounts/{id}/deliverability/block-rules/{provider}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unblock a mail provider for a mailbox
      effect: destructive
      questions:
      - Can I lift the block that stops my mailbox sending to one provider?
      - Is it possible to remove a provider block rule for just one campaign?
      instructions:
      - text: Unblock provider {provider} for email account {id}.
        slots:
          provider: path.provider
          id: path.id
      - text: Remove the {provider} block rule on mailbox {id} for campaign {campaignId}.
        slots:
          provider: path.provider
          id: path.id
          campaignId: query.campaignId
      method: generated
      generated: '2026-10-01'