Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Email REST Saved Message API

6 actions 6 updates phrasing extends openapi/listrak-savedmessage-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Listrak's API. It is a proposal applied on top of the contract, not a document Listrak publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v1/List/{listId}/SavedMessage'].get

$.paths['/v1/List/{listId}/SavedMessage'].post

$.paths['/v1/List/{listId}/SavedMessage/{savedMessageId}/Message'].post

$.paths['/v1/List/{listId}/SavedMessage/{savedMessageId}'].get

$.paths['/v1/List/{listId}/SavedMessage/{savedMessageId}'].put

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 Listrak Email REST Saved Message API
  version: 1.0.0
extends: openapi/listrak-savedmessage-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v1/List/{listId}/SavedMessage'].get
  update:
    x-apievangelist-phrasing:
      intent: List saved messages on a list
      effect: read
      questions:
      - What saved (draft) messages exist on a list?
      - Can I see all saved messages for an email list?
      instructions:
      - text: List saved messages on list {listId}.
        slots:
          listId: path.listId
      - text: Show the saved message drafts on email list {listId}.
        slots:
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/SavedMessage'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a saved message
      effect: write
      questions:
      - How do I save an email as a draft to send later?
      - Can I include a preheader when creating a saved message?
      instructions:
      - text: Create a saved message {savedMessageName} on list {listId} with subject {subject} from {fromName} <{fromEmail}>.
        slots:
          savedMessageName: requestBody.savedMessageName
          listId: path.listId
          subject: requestBody.subject
          fromName: requestBody.fromName
          fromEmail: requestBody.fromEmail
      - text: Save a new draft {savedMessageName} on list {listId}, subject {subject}, preheader {preheader}, from {fromName} <{fromEmail}>.
        slots:
          savedMessageName: requestBody.savedMessageName
          listId: path.listId
          subject: requestBody.subject
          preheader: requestBody.preheader
          fromName: requestBody.fromName
          fromEmail: requestBody.fromEmail
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/SavedMessage/{savedMessageId}/Message'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a saved message
      effect: write
      questions:
      - How do I send an email I previously saved?
      - Can I send a test of a saved message before the real send?
      instructions:
      - text: Send saved message {savedMessageId} on list {listId}.
        slots:
          savedMessageId: path.savedMessageId
          listId: path.listId
      - text: Send a test of saved message {savedMessageId} on list {listId} to {testEmailAddress}.
        slots:
          savedMessageId: path.savedMessageId
          listId: path.listId
          testEmailAddress: query.testEmailAddress
      - text: Schedule saved message {savedMessageId} on list {listId} to go out at {sendDate}.
        slots:
          savedMessageId: path.savedMessageId
          listId: path.listId
          sendDate: query.sendDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/SavedMessage/{savedMessageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a saved message
      effect: read
      questions:
      - How do I view the content of one saved message?
      - What subject line does a particular saved draft have?
      instructions:
      - text: Get saved message {savedMessageId} on list {listId}.
        slots:
          savedMessageId: path.savedMessageId
          listId: path.listId
      - text: Show the subject and body of saved draft {savedMessageId} from list {listId}.
        slots:
          savedMessageId: path.savedMessageId
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/SavedMessage/{savedMessageId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a saved message
      effect: write
      questions:
      - Can I edit a saved message's subject or HTML before sending?
      - How do I change the from address on a saved draft?
      instructions:
      - text: 'Update saved message {savedMessageId} on list {listId}: name {savedMessageName}, subject {subject}, from {fromName} <{fromEmail}>.'
        slots:
          savedMessageId: path.savedMessageId
          listId: path.listId
          savedMessageName: requestBody.savedMessageName
          subject: requestBody.subject
          fromName: requestBody.fromName
          fromEmail: requestBody.fromEmail
      - text: Edit saved draft {savedMessageId} on list {listId} with new HTML {bodyHtml}, keeping name {savedMessageName}, subject {subject}, from {fromName} <{fromEmail}>.
        slots:
          savedMessageId: path.savedMessageId
          listId: path.listId
          bodyHtml: requestBody.bodyHtml
          savedMessageName: requestBody.savedMessageName
          subject: requestBody.subject
          fromName: requestBody.fromName
          fromEmail: requestBody.fromEmail
      method: generated
      generated: '2026-09-26'