Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Email REST Event API

5 actions 5 updates phrasing extends openapi/listrak-event-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/List/{listId}/Event'].get
$.paths['/v1/List/{listId}/Event'].post
$.paths['/v1/List/{listId}/Event/{eventId}'].get
$.paths['/v1/List/{listId}/Event/{eventId}'].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 Event API
  version: 1.0.0
extends: openapi/listrak-event-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/List/{listId}/Event'].get
  update:
    x-apievangelist-phrasing:
      intent: List events on a list
      effect: read
      questions:
      - What subscription events are defined on an email list?
      - Can I see all events for a list?
      instructions:
      - text: List all events on list {listId}.
        slots:
          listId: path.listId
      - text: Show the events defined for email list {listId}.
        slots:
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/Event'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an event on a list
      effect: write
      questions:
      - How do I add a new event to an email list?
      - Can I put a new event into an event group when creating it?
      instructions:
      - text: Create an event named {eventName} on list {listId} with status {status}.
        slots:
          eventName: requestBody.eventName
          listId: path.listId
          status: requestBody.status
      - text: Add new event {eventName} to event group {eventGroupId} on list {listId}, status {status}.
        slots:
          eventName: requestBody.eventName
          eventGroupId: requestBody.eventGroupId
          listId: path.listId
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/Event/{eventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event
      effect: read
      questions:
      - How do I look up one event by ID on a list?
      - What status and group does a particular event have?
      instructions:
      - text: Get event {eventId} on list {listId}.
        slots:
          eventId: path.eventId
          listId: path.listId
      - text: Show the status and group of event {eventId} on list {listId}.
        slots:
          eventId: path.eventId
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/Event/{eventId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an event
      effect: write
      questions:
      - Can I rename an existing event or change its status?
      - How do I move an event to a different event group?
      instructions:
      - text: Update event {eventId} on list {listId} to name {eventName} with status {status}.
        slots:
          eventId: path.eventId
          listId: path.listId
          eventName: requestBody.eventName
          status: requestBody.status
      - text: Move existing event {eventId} on list {listId} into group {eventGroupId}, keeping name {eventName} and status {status}.
        slots:
          eventId: path.eventId
          listId: path.listId
          eventGroupId: requestBody.eventGroupId
          eventName: requestBody.eventName
          status: requestBody.status
      method: generated
      generated: '2026-09-26'