Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Subscriptions API

5 actions 5 updates phrasing extends openapi/live-direct-marketing-online-subscriptions-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 5

$.info
$.paths['/api/subscriptions'].post
$.paths['/api/subscriptions/verify'].get
$.paths['/api/subscriptions/unsubscribe'].get
$.paths['/api/subscriptions/unsubscribe'].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 Subscriptions API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-subscriptions-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: 4
- target: $.paths['/api/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to updates
      effect: write
      questions:
      - How do I sign up for email updates?
      - Can someone subscribe to the mailing list through the API?
      instructions:
      - text: Subscribe me to email updates.
      - text: Sign this address up for the mailing list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/subscriptions/verify'].get
  update:
    x-apievangelist-phrasing:
      intent: Confirm a subscription
      effect: write
      questions:
      - What does the confirmation link in a signup email do?
      - Can I verify a pending subscription with its token?
      instructions:
      - text: Verify the subscription with token {token}.
        slots:
          token: query.token
      - text: Confirm my signup using token {token}.
        slots:
          token: query.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/subscriptions/unsubscribe'].get
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe via an email link
      effect: destructive
      questions:
      - What happens when someone clicks the unsubscribe link in an email?
      - Can I opt out just by opening the unsubscribe URL?
      instructions:
      - text: Open the unsubscribe link for token {token}.
        slots:
          token: query.token
      - text: Unsubscribe by following the email link with token {token}.
        slots:
          token: query.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/subscriptions/unsubscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe with a one-click POST
      effect: destructive
      questions:
      - Is there a one-click POST unsubscribe that mail clients can call?
      - Can an unsubscribe be submitted as a form post rather than a link click?
      instructions:
      - text: Submit a one-click unsubscribe POST for token {token}.
        slots:
          token: query.token
      - text: Post an opt-out request with token {token}.
        slots:
          token: query.token
      method: generated
      generated: '2026-10-01'