# 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 Sender Links API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-sender-links-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: 7
- target: $.paths['/api/sender-links/unsubscribe'].get
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe from sender-link reports
      effect: write
      questions:
      - How do I stop getting sender-link email reports from the unsubscribe link?
      - What does the List-Unsubscribe link in a sender report do?
      instructions:
      - text: Unsubscribe me from sender-link reports with token {token}.
        slots:
          token: query.token
      - text: Open the unsubscribe link for token {token}.
        slots:
          token: query.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sender-links/unsubscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: One-click unsubscribe from sender reports
      effect: write
      questions:
      - Does one-click unsubscribe work for sender-link reports?
      - Can a mail client unsubscribe me automatically from sender reports?
      instructions:
      - text: Submit a one-click unsubscribe for token {token}.
        slots:
          token: query.token
      - text: Post the one-click unsubscribe with token {token}.
        slots:
          token: query.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sender-links/{linkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Open a public sender-link page
      effect: read
      questions:
      - What seed addresses should I add to my sends for a sender link?
      - Where's the public page showing a sender link's latest run and history?
      instructions:
      - text: Show the public sender page for link {link}.
        slots:
          link: path.linkId
      - text: Get seed addresses and run history from sender link {link}.
        slots:
          link: path.linkId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sender-links/{linkId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a sender link
      effect: destructive
      questions:
      - Can I shut down a sender link so its page stops working?
      - Does revoking a sender link stop the automatic runs?
      instructions:
      - text: Revoke sender link {link}.
        slots:
          link: path.linkId
      - text: Kill sender link {link} and stop its auto-runs.
        slots:
          link: path.linkId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sender-links/{linkId}/reports'].patch
  update:
    x-apievangelist-phrasing:
      intent: Turn sender-link email reports on or off
      effect: write
      questions:
      - Can I enable email reports for a sender link?
      - How do I mute report emails for one sender link?
      instructions:
      - text: Enable email reports for sender link {link}.
        slots:
          link: path.linkId
      - text: Turn off report emails on sender link {link}.
        slots:
          link: path.linkId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sender-links/{linkId}/reactivate'].post
  update:
    x-apievangelist-phrasing:
      intent: Reactivate a dormant sender link
      effect: write
      questions:
      - My sender link went dormant; can I wake it up?
      - Will the scanner start checking a reactivated sender link again?
      instructions:
      - text: Reactivate sender link {link}.
        slots:
          link: path.linkId
      - text: Wake dormant sender link {link} so it's scanned again.
        slots:
          link: path.linkId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/sender-links/{linkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a permanent sender page via API
      effect: read
      questions:
      - Can I fetch a sender page's seeds, recent runs and report setting through the v1 API?
      - Is there an API-key way to read a permanent sender page?
      instructions:
      - text: Get permanent sender page {link} through the v1 API.
        slots:
          link: path.linkId
      - text: Fetch sender link {link}'s reports state and latest runs via API.
        slots:
          link: path.linkId
      method: generated
      generated: '2026-10-01'