Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak SMS REST Broadcast Message API

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

$.info

$.paths['/v1/ShortCode/{senderCodeId}/Broadcast/Immediate'].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 SMS REST Broadcast Message API
  version: 1.0.0
extends: openapi/listrak-broadcastmessage-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: 1
- target: $.paths['/v1/ShortCode/{senderCodeId}/Broadcast/Immediate'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an SMS broadcast immediately
      effect: write
      questions:
      - How do I blast a text message right now to everyone subscribed on an SMS list?
      - Can I limit an immediate SMS broadcast to contacts with a checkbox profile field checked?
      - What is the broadcast title used for when sending an SMS blast?
      instructions:
      - text: Send an SMS broadcast titled {messageTitle} saying {messageContent} to SMS list {phoneListId} on sender code {senderCodeId} now.
        slots:
          messageTitle: requestBody.messageTitle
          messageContent: requestBody.messageContent
          phoneListId: requestBody.phoneListId
          senderCodeId: path.senderCodeId
      - text: 'Blast {messageTitle}: {messageContent} now to list {phoneListId}, sender code {senderCodeId}, only where checkbox {segmentationFieldId} is checked.'
        slots:
          messageContent: requestBody.messageContent
          phoneListId: requestBody.phoneListId
          senderCodeId: path.senderCodeId
          segmentationFieldId: requestBody.segmentationFieldId
          messageTitle: requestBody.messageTitle
      method: generated
      generated: '2026-09-26'