Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Transactional Message API

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

$.info

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

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

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

$.paths['/v1/ShortCode/{senderCodeId}/PhoneList/{phoneListId}/TransactionalMessage'].get

$.paths['/v1/ShortCode/{senderCodeId}/PhoneList/{phoneListId}/TransactionalMessage/{transactionalMessageId}'].get

$.paths['/v1/ShortCode/{SenderCodeId}/PhoneList/{phoneListId}/TransactionalMessage/{transactionalMessageId}/Message'].post

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 Transactional Message API
  version: 1.0.0
extends: openapi/listrak-transactionalmessage-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: 6
- target: $.paths['/v1/List/{listId}/TransactionalMessage/{transactionalMessageId}/Message'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a transactional email
      effect: write
      questions:
      - How do I send an order confirmation or receipt email to one person?
      - Can I personalize a transactional email with profile field values?
      instructions:
      - text: Send transactional email {transactionalMessageId} on list {listId} to {emailAddress}.
        slots:
          transactionalMessageId: path.transactionalMessageId
          listId: path.listId
          emailAddress: requestBody.emailAddress
      - text: Email {emailAddress} the transactional message {transactionalMessageId} from list {listId} with these field values {segmentationFieldValues}.
        slots:
          emailAddress: requestBody.emailAddress
          transactionalMessageId: path.transactionalMessageId
          listId: path.listId
          segmentationFieldValues: requestBody.segmentationFieldValues
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/TransactionalMessage'].get
  update:
    x-apievangelist-phrasing:
      intent: List transactional emails on a list
      effect: read
      questions:
      - What transactional email templates exist on my email list?
      - Can I see all transactional emails configured for a list?
      instructions:
      - text: List transactional emails on list {listId}.
        slots:
          listId: path.listId
      - text: Show the transactional email templates for email list {listId}.
        slots:
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/TransactionalMessage/{transactionalMessageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transactional email
      effect: read
      questions:
      - How do I look up one transactional email template by ID?
      - What does a specific transactional email contain?
      instructions:
      - text: Get transactional email {transactionalMessageId} on list {listId}.
        slots:
          transactionalMessageId: path.transactionalMessageId
          listId: path.listId
      - text: Show the content of transactional email template {transactionalMessageId} from list {listId}.
        slots:
          transactionalMessageId: path.transactionalMessageId
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ShortCode/{senderCodeId}/PhoneList/{phoneListId}/TransactionalMessage'].get
  update:
    x-apievangelist-phrasing:
      intent: List transactional SMS messages on an SMS list
      effect: read
      questions:
      - What transactional text messages are set up on an SMS list?
      - Can I see all transactional SMS templates for a sender code's list?
      instructions:
      - text: List transactional SMS messages on SMS list {phoneListId} for sender code {senderCodeId}.
        slots:
          phoneListId: path.phoneListId
          senderCodeId: path.senderCodeId
      - text: Show the transactional text templates on phone list {phoneListId} under sender code {senderCodeId}.
        slots:
          phoneListId: path.phoneListId
          senderCodeId: path.senderCodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ShortCode/{senderCodeId}/PhoneList/{phoneListId}/TransactionalMessage/{transactionalMessageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transactional SMS message
      effect: read
      questions:
      - How do I look up one transactional text message on an SMS list?
      - What does a specific transactional SMS say?
      instructions:
      - text: Get transactional SMS {transactionalMessageId} on SMS list {phoneListId}, sender code {senderCodeId}.
        slots:
          transactionalMessageId: path.transactionalMessageId
          phoneListId: path.phoneListId
          senderCodeId: path.senderCodeId
      - text: Show the text of transactional SMS template {transactionalMessageId} on phone list {phoneListId} (sender code {senderCodeId}).
        slots:
          transactionalMessageId: path.transactionalMessageId
          phoneListId: path.phoneListId
          senderCodeId: path.senderCodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ShortCode/{SenderCodeId}/PhoneList/{phoneListId}/TransactionalMessage/{transactionalMessageId}/Message'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a transactional SMS
      effect: write
      questions:
      - How do I text a one-off transactional message, like a shipping alert, to a phone number?
      - Can I override the content when sending a transactional SMS?
      instructions:
      - text: Text transactional SMS {transactionalMessageId} on list {phoneListId}, sender code {SenderCodeId}, to {phoneNumber}.
        slots:
          transactionalMessageId: path.transactionalMessageId
          phoneListId: path.phoneListId
          SenderCodeId: path.SenderCodeId
          phoneNumber: requestBody.phoneNumber
      - text: Send {phoneNumber} the transactional text {transactionalMessageId} from SMS list {phoneListId} (sender code {SenderCodeId}) with content {messageContent}.
        slots:
          phoneNumber: requestBody.phoneNumber
          transactionalMessageId: path.transactionalMessageId
          phoneListId: path.phoneListId
          SenderCodeId: path.SenderCodeId
          messageContent: requestBody.messageContent
      method: generated
      generated: '2026-09-26'