Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Email REST Conversation API

3 actions 3 updates phrasing extends openapi/listrak-conversation-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/List/{listId}/Conversation'].get
$.paths['/v1/List/{listId}/Conversation/{conversationId}'].get

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 Email REST Conversation API
  version: 1.0.0
extends: openapi/listrak-conversation-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/List/{listId}/Conversation'].get
  update:
    x-apievangelist-phrasing:
      intent: List conversations on a list
      effect: read
      questions:
      - Which conversations (automated email journeys) are set up on a list?
      - Can I see all conversations for an email list?
      instructions:
      - text: List all conversations on list {listId}.
        slots:
          listId: path.listId
      - text: Show me the conversations configured for email list {listId}.
        slots:
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/Conversation/{conversationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a conversation
      effect: read
      questions:
      - How do I look up one conversation by its ID?
      - What are the details of a specific conversation on my list?
      instructions:
      - text: Get conversation {conversationId} on list {listId}.
        slots:
          conversationId: path.conversationId
          listId: path.listId
      - text: Show details for conversation {conversationId} from list {listId}.
        slots:
          conversationId: path.conversationId
          listId: path.listId
      method: generated
      generated: '2026-09-26'