Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak SMS REST Contact List Subscription API

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

$.info

$.paths['/v1/ShortCode/{senderCodeId}/Contact/{phoneNumber}/PhoneList'].get

$.paths['/v1/ShortCode/{senderCodeId}/Contact/{phoneNumber}/PhoneList/{phoneListId}'].post

$.paths['/v1/ShortCode/{senderCodeId}/ContactUnsubscribe/{phoneNumber}/PhoneList/{phoneListId}'].delete

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 Contact List Subscription API
  version: 1.0.0
extends: openapi/listrak-contactlistsubscription-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: 3
- target: $.paths['/v1/ShortCode/{senderCodeId}/Contact/{phoneNumber}/PhoneList'].get
  update:
    x-apievangelist-phrasing:
      intent: List a phone contact's SMS lists
      effect: read
      questions:
      - Which SMS lists is a phone number subscribed to?
      - Can I see a texting contact's subscription status on each list?
      instructions:
      - text: Show the SMS lists that {phoneNumber} belongs to on sender code {senderCodeId}.
        slots:
          phoneNumber: path.phoneNumber
          senderCodeId: path.senderCodeId
      - text: List subscription status by list for phone {phoneNumber} under sender code {senderCodeId}.
        slots:
          phoneNumber: path.phoneNumber
          senderCodeId: path.senderCodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ShortCode/{senderCodeId}/Contact/{phoneNumber}/PhoneList/{phoneListId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe an existing contact to an SMS list
      effect: write
      questions:
      - How do I add a phone number that already exists on my sender code to another SMS list?
      - What happens if I try to subscribe a phone number that isn't on the sender code yet?
      instructions:
      - text: Subscribe existing contact {phoneNumber} to SMS list {phoneListId} on sender code {senderCodeId}.
        slots:
          phoneNumber: path.phoneNumber
          phoneListId: path.phoneListId
          senderCodeId: path.senderCodeId
      - text: Add {phoneNumber} to SMS list {phoneListId} for sender code {senderCodeId}.
        slots:
          phoneNumber: path.phoneNumber
          phoneListId: path.phoneListId
          senderCodeId: path.senderCodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ShortCode/{senderCodeId}/ContactUnsubscribe/{phoneNumber}/PhoneList/{phoneListId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe a contact from an SMS list
      effect: destructive
      questions:
      - How do I remove a phone number from one SMS list without opting it out everywhere?
      - Can I unsubscribe a texting contact from a specific list?
      instructions:
      - text: Unsubscribe {phoneNumber} from SMS list {phoneListId} on sender code {senderCodeId}.
        slots:
          phoneNumber: path.phoneNumber
          phoneListId: path.phoneListId
          senderCodeId: path.senderCodeId
      - text: Take {phoneNumber} off list {phoneListId} under sender code {senderCodeId}.
        slots:
          phoneNumber: path.phoneNumber
          phoneListId: path.phoneListId
          senderCodeId: path.senderCodeId
      method: generated
      generated: '2026-09-26'