Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Email REST List Import API

4 actions 4 updates phrasing extends openapi/listrak-list-import-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 4

$.info
$.paths['/v1/List/{listId}/ListImport'].get
$.paths['/v1/List/{listId}/ListImport'].post
$.paths['/v1/List/{listId}/ListImport/{importFileId}'].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 List Import API
  version: 1.0.0
extends: openapi/listrak-list-import-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/v1/List/{listId}/ListImport'].get
  update:
    x-apievangelist-phrasing:
      intent: List imports run on a list
      effect: read
      questions:
      - What imports have been run against one of my lists?
      - Can I see list imports from a specific date range?
      instructions:
      - text: List all imports on list {listId}.
        slots:
          listId: path.listId
      - text: Show imports on list {listId} between {startDate} and {endDate}.
        slots:
          listId: path.listId
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/List/{listId}/ListImport'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a list import from a file
      effect: write
      questions:
      - How do I bulk upload a file of subscribers to an email list?
      - What is the maximum file size for a list import?
      - Can I trigger journeys or suppress notifications when importing a list?
      instructions:
      - text: Import file {fileName} into list {listId} as a {importType} import.
        slots:
          fileName: requestBody.fileName
          listId: path.listId
          importType: requestBody.importType
      - text: Start a list import on {listId} from {fileName} with delimiter {fileDelimiter} and trigger journeys.
        slots:
          listId: path.listId
          fileName: requestBody.fileName
          fileDelimiter: requestBody.fileDelimiter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/List/{listId}/ListImport/{importFileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a list import
      effect: read
      questions:
      - How do I retrieve the details of one list import?
      - Can I look up a list import by its import file ID?
      instructions:
      - text: Get import {importFileId} on list {listId}.
        slots:
          importFileId: path.importFileId
          listId: path.listId
      - text: Show details of list import {importFileId} for list {listId}.
        slots:
          importFileId: path.importFileId
          listId: path.listId
      method: generated
      generated: '2026-10-01'