Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Email REST Conversation Message API

3 actions 3 updates phrasing extends openapi/listrak-conversationmessage-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/{conversationId}/Message'].get

$.paths['/v1/List/{listId}/Conversation/{conversationId}/Message/{conversationMessageId}'].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 Email REST Conversation Message API
  version: 1.0.0
extends: openapi/listrak-conversationmessage-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/{conversationId}/Message'].get
  update:
    x-apievangelist-phrasing:
      intent: List messages in a conversation
      effect: read
      questions:
      - What messages make up a conversation?
      - Can I include previous versions of conversation messages in the results?
      instructions:
      - text: List the messages in conversation {conversationId} on list {listId}.
        slots:
          conversationId: path.conversationId
          listId: path.listId
      - text: List conversation {conversationId} messages on list {listId}, including previous versions.
        slots:
          conversationId: path.conversationId
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/Conversation/{conversationId}/Message/{conversationMessageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a conversation message
      effect: read
      questions:
      - How do I retrieve one specific message within a conversation?
      - Can I see the content of a single conversation message?
      instructions:
      - text: Get message {conversationMessageId} in conversation {conversationId} on list {listId}.
        slots:
          conversationMessageId: path.conversationMessageId
          conversationId: path.conversationId
          listId: path.listId
      - text: Show conversation message {conversationMessageId} from conversation {conversationId}, list {listId}.
        slots:
          conversationMessageId: path.conversationMessageId
          conversationId: path.conversationId
          listId: path.listId
      method: generated
      generated: '2026-09-26'