Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak SMS REST Phone List API

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

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

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 Listrak SMS REST Phone List API
  version: 1.0.0
extends: openapi/listrak-phonelist-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: 2
- target: $.paths['/v1/ShortCode/{senderCodeId}/PhoneList'].get
  update:
    x-apievangelist-phrasing:
      intent: List SMS lists for a sender code
      effect: read
      questions:
      - What SMS lists exist under my sender code?
      - Can I filter SMS lists by their status?
      instructions:
      - text: List SMS lists for sender code {senderCodeId}.
        slots:
          senderCodeId: path.senderCodeId
      - text: Show {status} SMS lists on sender code {senderCodeId}.
        slots:
          status: query.status
          senderCodeId: path.senderCodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ShortCode/{senderCodeId}/PhoneList/{phoneListId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SMS list
      effect: read
      questions:
      - How do I look up one SMS list by its ID?
      - What are the details of a specific SMS list?
      instructions:
      - text: Get SMS list {phoneListId} on sender code {senderCodeId}.
        slots:
          phoneListId: path.phoneListId
          senderCodeId: path.senderCodeId
      - text: Show details for SMS list {phoneListId} under sender code {senderCodeId}.
        slots:
          phoneListId: path.phoneListId
          senderCodeId: path.senderCodeId
      method: generated
      generated: '2026-09-26'