Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Email REST Message API

4 actions 4 updates phrasing extends openapi/listrak-message-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 4

$.info

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

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

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

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 Message API
  version: 1.0.0
extends: openapi/listrak-message-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: 3
- target: $.paths['/v1/List/{listId}/Message'].get
  update:
    x-apievangelist-phrasing:
      intent: List messages sent on a list
      effect: read
      questions:
      - What email messages have been sent on a list?
      - Can I include test messages when listing a list's sends?
      instructions:
      - text: List messages on list {listId}.
        slots:
          listId: path.listId
      - text: Show messages sent on list {listId} from {startDate} to {endDate}.
        slots:
          listId: path.listId
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/Message'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an email message to a list
      effect: write
      questions:
      - How do I send a new email blast to a list?
      - Can I schedule an email for later or send a test first?
      - Can I send a message to just a saved audience instead of the whole list?
      instructions:
      - text: Send a message with subject {subject} from {fromName} <{fromEmail}> to list {listId}, external campaign {externalCampaignId}.
        slots:
          subject: requestBody.subject
          fromName: requestBody.fromName
          fromEmail: requestBody.fromEmail
          listId: path.listId
          externalCampaignId: requestBody.externalCampaignId
      - text: Send a test of email {subject} on list {listId} to {testEmailAddress}.
        slots:
          subject: requestBody.subject
          listId: path.listId
          testEmailAddress: query.testEmailAddress
      - text: Schedule email {subject} on list {listId} for {sendDate}.
        slots:
          subject: requestBody.subject
          listId: path.listId
          sendDate: query.sendDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/Message/{messageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sent message
      effect: read
      questions:
      - How do I retrieve one email message by its ID?
      - Can I see the subject and content of a message I sent?
      instructions:
      - text: Get message {messageId} on list {listId}.
        slots:
          messageId: path.messageId
          listId: path.listId
      - text: Show the subject and body of message {messageId} from list {listId}.
        slots:
          messageId: path.messageId
          listId: path.listId
      method: generated
      generated: '2026-09-26'