Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Email REST Folder API

5 actions 5 updates phrasing extends openapi/listrak-folder-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 5

$.info
$.paths['/v1/Folder'].get
$.paths['/v1/Folder'].post
$.paths['/v1/Folder/{folderId}'].get
$.paths['/v1/Folder/{folderId}'].put

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 Folder API
  version: 1.0.0
extends: openapi/listrak-folder-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: 4
- target: $.paths['/v1/Folder'].get
  update:
    x-apievangelist-phrasing:
      intent: List account folders
      effect: read
      questions:
      - What folders do I have for organizing lists?
      - Can I get all folders in my account?
      instructions:
      - text: List all folders in my account.
      - text: Show the folders I use to organize lists.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Folder'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a folder
      effect: write
      questions:
      - How do I create a new folder to organize my lists?
      - What do I need to add a folder to my account?
      instructions:
      - text: Create a folder named {folderName}.
        slots:
          folderName: requestBody.folderName
      - text: Add a new account folder called {folderName} for my lists.
        slots:
          folderName: requestBody.folderName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Folder/{folderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a folder
      effect: read
      questions:
      - How do I look up one folder by its ID?
      - What is a particular folder called?
      instructions:
      - text: Get folder {folderId}.
        slots:
          folderId: path.folderId
      - text: Show the name of folder {folderId}.
        slots:
          folderId: path.folderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Folder/{folderId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a folder
      effect: write
      questions:
      - Can I rename a folder that already exists?
      - How do I update an existing account folder?
      instructions:
      - text: Rename folder {folderId} to {folderName}.
        slots:
          folderId: path.folderId
          folderName: requestBody.folderName
      - text: Update existing folder {folderId} with name {folderName}.
        slots:
          folderId: path.folderId
          folderName: requestBody.folderName
      method: generated
      generated: '2026-09-26'