Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Email REST Campaign API

6 actions 6 updates phrasing extends openapi/listrak-campaign-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/{listId}/Campaign'].get

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

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

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

$.paths['/v1/List/{listId}/Campaign/{campaignId}'].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 Campaign API
  version: 1.0.0
extends: openapi/listrak-campaign-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/{listId}/Campaign'].get
  update:
    x-apievangelist-phrasing:
      intent: List campaigns on an email list
      effect: read
      questions:
      - Which campaigns exist on one of my email lists?
      - Can I see every campaign set up for a list?
      instructions:
      - text: List all campaigns on list {listId}.
        slots:
          listId: path.listId
      - text: Show me the campaign names configured for email list {listId}.
        slots:
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/Campaign'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a campaign on a list
      effect: write
      questions:
      - How do I add a new campaign to an email list for grouping messages?
      - What do I need to create a campaign besides its name?
      instructions:
      - text: Create a campaign named {campaignName} on list {listId}.
        slots:
          campaignName: requestBody.campaignName
          listId: path.listId
      - text: Add a new campaign called {campaignName} to email list {listId}.
        slots:
          campaignName: requestBody.campaignName
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/Campaign/{campaignId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one campaign's details
      effect: read
      questions:
      - How can I look up a single campaign by its ID on a list?
      - What name is a particular campaign stored under?
      instructions:
      - text: Get campaign {campaignId} from list {listId}.
        slots:
          campaignId: path.campaignId
          listId: path.listId
      - text: Look up the name of campaign {campaignId} on list {listId}.
        slots:
          campaignId: path.campaignId
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/Campaign/{campaignId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename an existing campaign
      effect: write
      questions:
      - Can I rename a campaign I already created?
      - How do I update an existing campaign on a list?
      instructions:
      - text: Rename campaign {campaignId} on list {listId} to {campaignName}.
        slots:
          campaignId: path.campaignId
          listId: path.listId
          campaignName: requestBody.campaignName
      - text: Update the existing campaign {campaignId} on list {listId} with name {campaignName}.
        slots:
          campaignId: path.campaignId
          listId: path.listId
          campaignName: requestBody.campaignName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/Campaign/{campaignId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a campaign
      effect: destructive
      questions:
      - How do I remove a campaign I no longer need from a list?
      - Is there a way to delete a campaign permanently?
      instructions:
      - text: Delete campaign {campaignId} from list {listId}.
        slots:
          campaignId: path.campaignId
          listId: path.listId
      - text: Remove the old campaign {campaignId} on list {listId}.
        slots:
          campaignId: path.campaignId
          listId: path.listId
      method: generated
      generated: '2026-09-26'