Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Two-Way SMS Tickets API

3 actions 3 updates phrasing extends openapi/listrak-tickets-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['/tickets'].post
$.paths['/tickets'].delete

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 Two-Way SMS Tickets API
  version: 1.0.0
extends: openapi/listrak-tickets-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['/tickets'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a two-way SMS support ticket
      effect: write
      questions:
      - How do I start a support ticket for an SMS conversation from my helpdesk?
      - Can I link a two-way SMS thread to my own ticket ID?
      instructions:
      - text: Open a ticket {externalTicketId} for the SMS conversation with phone {phoneId}.
        slots:
          externalTicketId: requestBody.externalTicketId
          phoneId: requestBody.phoneId
      - text: Start a two-way SMS ticket for phone {phoneId} via integration {integrationType}.
        slots:
          phoneId: requestBody.phoneId
          integrationType: requestBody.integrationType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tickets'].delete
  update:
    x-apievangelist-phrasing:
      intent: Close a two-way SMS support ticket
      effect: destructive
      questions:
      - How do I close the SMS support ticket for a phone once it's resolved?
      - Can I end a two-way texting ticket from my helpdesk integration?
      instructions:
      - text: Close the SMS ticket for phone {phoneId}.
        slots:
          phoneId: requestBody.phoneId
      - text: End the open two-way ticket for phone {phoneId} on integration {integrationType}.
        slots:
          phoneId: requestBody.phoneId
          integrationType: requestBody.integrationType
      method: generated
      generated: '2026-09-26'