Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Email REST Event Group API

6 actions 6 updates phrasing extends openapi/listrak-eventgroup-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}/EventGroup'].get

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

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

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

$.paths['/v1/List/{listId}/EventGroup/{eventGroupId}'].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 Event Group API
  version: 1.0.0
extends: openapi/listrak-eventgroup-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}/EventGroup'].get
  update:
    x-apievangelist-phrasing:
      intent: List event groups on a list
      effect: read
      questions:
      - What event groups exist on my list?
      - Can I see all event groups for an email list?
      instructions:
      - text: List all event groups on list {listId}.
        slots:
          listId: path.listId
      - text: Show the event groups set up for email list {listId}.
        slots:
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/EventGroup'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an event group
      effect: write
      questions:
      - How do I create a group to organize events on a list?
      - What do I need to add a new event group?
      instructions:
      - text: Create an event group named {eventGroupName} on list {listId}.
        slots:
          eventGroupName: requestBody.eventGroupName
          listId: path.listId
      - text: Add a new event group {eventGroupName} to email list {listId}.
        slots:
          eventGroupName: requestBody.eventGroupName
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/EventGroup/{eventGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event group
      effect: read
      questions:
      - How do I look up one event group by its ID?
      - What name does a given event group have?
      instructions:
      - text: Get event group {eventGroupId} on list {listId}.
        slots:
          eventGroupId: path.eventGroupId
          listId: path.listId
      - text: Show the name of event group {eventGroupId} from list {listId}.
        slots:
          eventGroupId: path.eventGroupId
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/EventGroup/{eventGroupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename an event group
      effect: write
      questions:
      - Can I rename an event group that already exists?
      - How do I update an existing event group?
      instructions:
      - text: Rename event group {eventGroupId} on list {listId} to {eventGroupName}.
        slots:
          eventGroupId: path.eventGroupId
          listId: path.listId
          eventGroupName: requestBody.eventGroupName
      - text: Update existing event group {eventGroupId} on list {listId} with name {eventGroupName}.
        slots:
          eventGroupId: path.eventGroupId
          listId: path.listId
          eventGroupName: requestBody.eventGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/EventGroup/{eventGroupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an event group
      effect: destructive
      questions:
      - How do I remove an event group from a list?
      - Can I delete an event group I no longer use?
      instructions:
      - text: Delete event group {eventGroupId} from list {listId}.
        slots:
          eventGroupId: path.eventGroupId
          listId: path.listId
      - text: Remove the unused event group {eventGroupId} on list {listId}.
        slots:
          eventGroupId: path.eventGroupId
          listId: path.listId
      method: generated
      generated: '2026-09-26'