Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Email REST Message Link API

3 actions 3 updates phrasing extends openapi/listrak-messagelink-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}/Message/{messageId}/Link'].get
$.paths['/v1/List/{listId}/Message/{messageId}/Link/{messageLinkId}'].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 Message Link API
  version: 1.0.0
extends: openapi/listrak-messagelink-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}/Message/{messageId}/Link'].get
  update:
    x-apievangelist-phrasing:
      intent: List links in an email message
      effect: read
      questions:
      - What links are tracked in an email I sent?
      - Can I list every URL in a message?
      instructions:
      - text: List links in message {messageId} on list {listId}.
        slots:
          messageId: path.messageId
          listId: path.listId
      - text: Show tracked URLs in email {messageId} from list {listId}.
        slots:
          messageId: path.messageId
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/Message/{messageId}/Link/{messageLinkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one link in an email message
      effect: read
      questions:
      - How do I look up a single tracked link in a message?
      - Where does a specific message link point?
      instructions:
      - text: Get link {messageLinkId} in message {messageId} on list {listId}.
        slots:
          messageLinkId: path.messageLinkId
          messageId: path.messageId
          listId: path.listId
      - text: Show the URL behind link {messageLinkId} in email {messageId}, list {listId}.
        slots:
          messageLinkId: path.messageLinkId
          messageId: path.messageId
          listId: path.listId
      method: generated
      generated: '2026-09-26'