Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Email REST Message Status API

2 actions 2 updates phrasing extends openapi/listrak-messagestatus-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 2

$.info

$.paths['/v1/List/{listId}/Message/{messageId}/Status'].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 Status API
  version: 1.0.0
extends: openapi/listrak-messagestatus-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: 1
- target: $.paths['/v1/List/{listId}/Message/{messageId}/Status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an email message's send status
      effect: read
      questions:
      - Has my email finished sending yet?
      - How do I check the send status of a message?
      instructions:
      - text: Get the send status of message {messageId} on list {listId}.
        slots:
          messageId: path.messageId
          listId: path.listId
      - text: Check whether message {messageId} on list {listId} is done sending.
        slots:
          messageId: path.messageId
          listId: path.listId
      method: generated
      generated: '2026-09-26'