Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Email REST Segmentation Field API

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

$.info
$.paths['/v1/List/{listId}/SegmentationFieldGroup/{segmentationFieldGroupId}/SegmentationField'].get
$.paths['/v1/List/{listId}/SegmentationFieldGroup/{segmentationFieldGroupId}/SegmentationField'].post
$.paths['/v1/List/{listId}/SegmentationFieldGroup/{segmentationFieldGroupId}/SegmentationField/{segmentationFieldId}'].get
$.paths['/v1/List/{listId}/SegmentationFieldGroup/{segmentationFieldGroupId}/SegmentationField/{segmentationFieldId}'].put
$.paths['/v1/List/{listId}/SegmentationFieldGroup/{segmentationFieldGroupId}/SegmentationField/{segmentationFieldId}'].delete
$.paths['/v1/List/{listId}/SegmentationFieldGroup/{segmentationFieldGroupId}/SegmentationField/{segmentationFieldId}/Values'].delete

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 Segmentation Field API
  version: 1.0.0
extends: openapi/listrak-segmentationfield-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: 6
- target: $.paths['/v1/List/{listId}/SegmentationFieldGroup/{segmentationFieldGroupId}/SegmentationField'].get
  update:
    x-apievangelist-phrasing:
      intent: List profile fields in a field group
      effect: read
      questions:
      - What profile fields are in a profile field group?
      - Can I see every profile field under a group on my list?
      instructions:
      - text: List profile fields in group {segmentationFieldGroupId} on list {listId}.
        slots:
          segmentationFieldGroupId: path.segmentationFieldGroupId
          listId: path.listId
      - text: Show all fields in profile field group {segmentationFieldGroupId} for list {listId}.
        slots:
          segmentationFieldGroupId: path.segmentationFieldGroupId
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/SegmentationFieldGroup/{segmentationFieldGroupId}/SegmentationField'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a profile field
      effect: write
      questions:
      - How do I add a new custom profile field to a field group?
      - What data type and max length do I set for a new profile field?
      instructions:
      - text: Create field {segmentationFieldName} ({dataType}, length {maxLength}, position {position}) in group {segmentationFieldGroupId}, list {listId}.
        slots:
          segmentationFieldName: requestBody.segmentationFieldName
          dataType: requestBody.dataType
          maxLength: requestBody.maxLength
          position: requestBody.position
          segmentationFieldGroupId: path.segmentationFieldGroupId
          listId: path.listId
      - text: Add a new {dataType} field {segmentationFieldName} to profile group {segmentationFieldGroupId}, list {listId}, length {maxLength}, at position {position}.
        slots:
          dataType: requestBody.dataType
          segmentationFieldName: requestBody.segmentationFieldName
          segmentationFieldGroupId: path.segmentationFieldGroupId
          listId: path.listId
          maxLength: requestBody.maxLength
          position: requestBody.position
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/SegmentationFieldGroup/{segmentationFieldGroupId}/SegmentationField/{segmentationFieldId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a profile field
      effect: read
      questions:
      - How do I look up one profile field on an email list?
      - What data type and length does a given profile field have?
      instructions:
      - text: Get profile field {segmentationFieldId} in group {segmentationFieldGroupId} on list {listId}.
        slots:
          segmentationFieldId: path.segmentationFieldId
          segmentationFieldGroupId: path.segmentationFieldGroupId
          listId: path.listId
      - text: Show the data type of field {segmentationFieldId} (group {segmentationFieldGroupId}, list {listId}).
        slots:
          segmentationFieldId: path.segmentationFieldId
          segmentationFieldGroupId: path.segmentationFieldGroupId
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/SegmentationFieldGroup/{segmentationFieldGroupId}/SegmentationField/{segmentationFieldId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a profile field definition
      effect: write
      questions:
      - Can I rename or reposition an existing profile field?
      - How do I change a profile field's max length?
      instructions:
      - text: Set field {segmentationFieldId} (group {segmentationFieldGroupId}, list {listId}) to {segmentationFieldName}, {dataType}, len {maxLength}, position {position}.
        slots:
          segmentationFieldId: path.segmentationFieldId
          segmentationFieldGroupId: path.segmentationFieldGroupId
          listId: path.listId
          segmentationFieldName: requestBody.segmentationFieldName
          dataType: requestBody.dataType
          maxLength: requestBody.maxLength
          position: requestBody.position
      - text: Change existing field {segmentationFieldId} max length to {maxLength} (group {segmentationFieldGroupId}, list {listId}).
        slots:
          segmentationFieldId: path.segmentationFieldId
          maxLength: requestBody.maxLength
          segmentationFieldGroupId: path.segmentationFieldGroupId
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/SegmentationFieldGroup/{segmentationFieldGroupId}/SegmentationField/{segmentationFieldId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a profile field
      effect: destructive
      questions:
      - How do I remove a profile field definition entirely?
      - Can I delete a custom profile field from a group?
      instructions:
      - text: Delete profile field {segmentationFieldId} from group {segmentationFieldGroupId} on list {listId}.
        slots:
          segmentationFieldId: path.segmentationFieldId
          segmentationFieldGroupId: path.segmentationFieldGroupId
          listId: path.listId
      - text: Remove the field {segmentationFieldId} itself from profile group {segmentationFieldGroupId}, list {listId}.
        slots:
          segmentationFieldId: path.segmentationFieldId
          segmentationFieldGroupId: path.segmentationFieldGroupId
          listId: path.listId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/List/{listId}/SegmentationFieldGroup/{segmentationFieldGroupId}/SegmentationField/{segmentationFieldId}/Values'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear a profile field's values for all contacts
      effect: destructive
      questions:
      - How do I wipe the stored values of a profile field for every subscriber but keep the field?
      - Can I poll the progress of clearing profile field values?
      instructions:
      - text: Clear all contact values of profile field {segmentationFieldId} in group {segmentationFieldGroupId} on list {listId}.
        slots:
          segmentationFieldId: path.segmentationFieldId
          segmentationFieldGroupId: path.segmentationFieldGroupId
          listId: path.listId
      - text: Blank out field {segmentationFieldId} for every subscribed contact (group {segmentationFieldGroupId}, list {listId}).
        slots:
          segmentationFieldId: path.segmentationFieldId
          segmentationFieldGroupId: path.segmentationFieldGroupId
          listId: path.listId
      method: generated
      generated: '2026-09-26'