Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak SMS REST Segmentation API

3 actions 3 updates phrasing extends openapi/listrak-segmentation-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}/SegmentationField/{segmentationFieldId}'].get

$.paths['/v1/ShortCode/{senderCodeId}/SegmentationField'].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 Segmentation API
  version: 1.0.0
extends: openapi/listrak-segmentation-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}/SegmentationField/{segmentationFieldId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SMS profile field
      effect: read
      questions:
      - How do I look up one SMS profile field for my sender code?
      - What type is a specific texting profile field?
      instructions:
      - text: Get SMS profile field {segmentationFieldId} on sender code {senderCodeId}.
        slots:
          segmentationFieldId: path.segmentationFieldId
          senderCodeId: path.senderCodeId
      - text: Show details of profile field {segmentationFieldId} for sender code {senderCodeId}.
        slots:
          segmentationFieldId: path.segmentationFieldId
          senderCodeId: path.senderCodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ShortCode/{senderCodeId}/SegmentationField'].get
  update:
    x-apievangelist-phrasing:
      intent: List SMS profile fields
      effect: read
      questions:
      - What profile fields are available for SMS contacts on my sender code?
      - Can I get every texting profile field for the company?
      instructions:
      - text: List all SMS profile fields for sender code {senderCodeId}.
        slots:
          senderCodeId: path.senderCodeId
      - text: Show the profile fields I can set on texting contacts under sender code {senderCodeId}.
        slots:
          senderCodeId: path.senderCodeId
      method: generated
      generated: '2026-09-26'