Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Email REST List API

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

$.info

$.paths['/v1/List'].get

$.paths['/v1/List'].post

$.paths['/v1/List/{listId}'].get

$.paths['/v1/List/{listId}'].put

$.paths['/v1/List/{listId}'].delete

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 List API
  version: 1.0.0
extends: openapi/listrak-list-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: 5
- target: $.paths['/v1/List'].get
  update:
    x-apievangelist-phrasing:
      intent: List all email lists
      effect: read
      questions:
      - What email lists are in my account?
      - Can I get the IDs of every list I have?
      instructions:
      - text: List all email lists in my account.
      - text: Show me every list and its ID.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email list
      effect: write
      questions:
      - How do I create a new email list?
      - Can I turn on double opt-in and set a from address when creating a list?
      - What bounce handling settings are required for a new list?
      instructions:
      - text: Create a list named {listName} with bounce handling {bounceHandling} and unsubscribe after {bounceUnsubscribeCount} bounces.
        slots:
          listName: requestBody.listName
          bounceHandling: requestBody.bounceHandling
          bounceUnsubscribeCount: requestBody.bounceUnsubscribeCount
      - text: Make a new email list {listName} sending from {fromEmail}, bounce handling {bounceHandling}, bounce limit {bounceUnsubscribeCount}.
        slots:
          listName: requestBody.listName
          fromEmail: requestBody.fromEmail
          bounceHandling: requestBody.bounceHandling
          bounceUnsubscribeCount: requestBody.bounceUnsubscribeCount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email list's settings
      effect: read
      questions:
      - How do I see the settings of one email list?
      - Is double opt-in enabled on a particular list?
      instructions:
      - text: Get list {listId}.
        slots:
          listId: path.listId
      - text: Show the from address and opt-in settings for list {listId}.
        slots:
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an email list's settings
      effect: write
      questions:
      - Can I change the name or from address of an existing list?
      - How do I move a list to a different IP pool?
      instructions:
      - text: 'Update list {listId}: rename to {listName}, bounce handling {bounceHandling}, bounce limit {bounceUnsubscribeCount}.'
        slots:
          listId: path.listId
          listName: requestBody.listName
          bounceHandling: requestBody.bounceHandling
          bounceUnsubscribeCount: requestBody.bounceUnsubscribeCount
      - text: Assign existing list {listId} to IP pool {ipPoolId}.
        slots:
          listId: path.listId
          ipPoolId: requestBody.ipPoolId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email list
      effect: destructive
      questions:
      - How do I delete an email list I no longer use?
      - Can I permanently remove a list from my account?
      instructions:
      - text: Delete list {listId}.
        slots:
          listId: path.listId
      - text: Permanently remove email list {listId} from my account.
        slots:
          listId: path.listId
      method: generated
      generated: '2026-09-26'