Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Unsubscribe API

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

$.info
$.paths['/api/unsubscribe/{token}'].get
$.paths['/api/unsubscribe/{token}'].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 Unsubscribe API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-unsubscribe-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: 2
- target: $.paths['/api/unsubscribe/{token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Process an unsubscribe link click
      effect: write
      questions:
      - What happens when a recipient clicks the unsubscribe link in an email?
      - Which endpoint does the unsubscribe link in the email footer open?
      instructions:
      - text: Open the unsubscribe link for token {token}.
        slots:
          token: path.token
      - text: Unsubscribe the recipient behind link token {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/unsubscribe/{token}'].post
  update:
    x-apievangelist-phrasing:
      intent: Handle an RFC 8058 one-click unsubscribe
      effect: write
      questions:
      - Does the platform support RFC 8058 one-click unsubscribe from mail clients?
      - How do mailbox providers unsubscribe a recipient with a single POST?
      instructions:
      - text: Send a one-click unsubscribe for token {token}.
        slots:
          token: path.token
      - text: Process the RFC 8058 List-Unsubscribe-Post for {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'