Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak SMS REST Sender Code API

3 actions 3 updates phrasing extends openapi/listrak-sendercode-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'].get

$.paths['/v1/ShortCode/{senderCodeId}'].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 SMS REST Sender Code API
  version: 1.0.0
extends: openapi/listrak-sendercode-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List SMS sender codes
      effect: read
      questions:
      - What SMS sender codes does my company have?
      - Where do I find my short code IDs?
      instructions:
      - text: List all SMS sender codes for my company.
      - text: Show me my short codes and their IDs.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ShortCode/{senderCodeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SMS sender code
      effect: read
      questions:
      - How do I look up the details of one sender code?
      - What settings does a particular short code have?
      instructions:
      - text: Get SMS sender code {senderCodeId}.
        slots:
          senderCodeId: path.senderCodeId
      - text: Show details for short code {senderCodeId}.
        slots:
          senderCodeId: path.senderCodeId
      method: generated
      generated: '2026-09-26'