Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Email REST Segmentation Field Group API

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

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

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

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

$.paths['/v1/List/{listId}/SegmentationFieldGroup/{segmentationFieldGroupId}'].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 Segmentation Field Group API
  version: 1.0.0
extends: openapi/listrak-segmentationfieldgroup-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}/SegmentationFieldGroup'].get
  update:
    x-apievangelist-phrasing:
      intent: List profile field groups
      effect: read
      questions:
      - What profile field groups exist on my list?
      - Can I see all groups of profile fields for a list?
      instructions:
      - text: List profile field groups on list {listId}.
        slots:
          listId: path.listId
      - text: Show the profile field groups for email list {listId}.
        slots:
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/SegmentationFieldGroup'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a profile field group
      effect: write
      questions:
      - How do I create a new group to hold profile fields?
      - What position do I give a new profile field group?
      instructions:
      - text: Create profile field group {segmentationFieldGroupName} at position {position} on list {listId}.
        slots:
          segmentationFieldGroupName: requestBody.segmentationFieldGroupName
          position: requestBody.position
          listId: path.listId
      - text: Add a new field group called {segmentationFieldGroupName} to list {listId}, position {position}.
        slots:
          segmentationFieldGroupName: requestBody.segmentationFieldGroupName
          listId: path.listId
          position: requestBody.position
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/SegmentationFieldGroup/{segmentationFieldGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a profile field group
      effect: read
      questions:
      - How do I look up a single profile field group?
      - What name and position does a profile field group have?
      instructions:
      - text: Get profile field group {segmentationFieldGroupId} on list {listId}.
        slots:
          segmentationFieldGroupId: path.segmentationFieldGroupId
          listId: path.listId
      - text: Show the name and position of field group {segmentationFieldGroupId} on list {listId}.
        slots:
          segmentationFieldGroupId: path.segmentationFieldGroupId
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/SegmentationFieldGroup/{segmentationFieldGroupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a profile field group
      effect: write
      questions:
      - Can I rename or reorder an existing profile field group?
      - How do I update a profile field group?
      instructions:
      - text: Update field group {segmentationFieldGroupId} on list {listId} to name {segmentationFieldGroupName}, position {position}.
        slots:
          segmentationFieldGroupId: path.segmentationFieldGroupId
          listId: path.listId
          segmentationFieldGroupName: requestBody.segmentationFieldGroupName
          position: requestBody.position
      - text: Rename existing field group {segmentationFieldGroupId} on list {listId} to {segmentationFieldGroupName}.
        slots:
          segmentationFieldGroupId: path.segmentationFieldGroupId
          listId: path.listId
          segmentationFieldGroupName: requestBody.segmentationFieldGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/SegmentationFieldGroup/{segmentationFieldGroupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a profile field group
      effect: destructive
      questions:
      - How do I delete a whole profile field group?
      - Can I remove a group of profile fields from a list?
      instructions:
      - text: Delete profile field group {segmentationFieldGroupId} from list {listId}.
        slots:
          segmentationFieldGroupId: path.segmentationFieldGroupId
          listId: path.listId
      - text: Remove the entire field group {segmentationFieldGroupId} on list {listId}.
        slots:
          segmentationFieldGroupId: path.segmentationFieldGroupId
          listId: path.listId
      method: generated
      generated: '2026-09-26'