# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Segments Match All API
  version: 1.0.0
extends: openapi/activecampaign-match-all-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['/api/3/segmentMatchAll'].post
  update:
    x-apievangelist-phrasing:
      intent: Find all contacts matching a new segment definition
      effect: read
      questions:
      - How do I get every contact ID that matches segment conditions I define on the fly?
      - Can I run a segment match without saving the segment permanently?
      - What is the largest page size for segment match results?
      instructions:
      - text: 'Find all contacts matching this segment definition: {data}.'
        slots:
          data: requestBody.data
      - text: Start a match-all for segment conditions {data} and return a run ID right away with instant {instant}.
        slots:
          data: requestBody.data
          instant: query.instant
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/3/segmentMatchAll/{segmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Find all contacts in a saved segment
      effect: read
      questions:
      - How do I list every contact that matches a segment I already have?
      - Can I start a match-all run for an existing segment ID and poll later?
      instructions:
      - text: Run a match-all for existing segment {segmentId}.
        slots:
          segmentId: path.segmentId
      - text: Get contacts in saved segment {segmentId} sorted by {sort}, {page_size} per page.
        slots:
          segmentId: path.segmentId
          sort: query.sort
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/3/segmentMatchAll/{segmentId}/{runId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the results of a match-all run
      effect: read
      questions:
      - How do I check whether my segment match-all run has finished?
      - Can I re-sort the cached results of a match-all run?
      instructions:
      - text: Get match-all results for run {runId} of segment {segmentId}.
        slots:
          runId: path.runId
          segmentId: path.segmentId
      - text: Fetch page {page} of match-all run {runId} for segment {segmentId} sorted by {sort}.
        slots:
          page: query.page
          runId: path.runId
          segmentId: path.segmentId
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/3/segmentMatchSome/{segmentId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Check which given contacts match a segment
      effect: read
      questions:
      - Can I test whether a handful of specific contacts fall into a segment?
      - How do I run a match-some request against a segment?
      instructions:
      - text: 'Check which of these contacts match segment {segmentId}: {data}.'
        slots:
          segmentId: path.segmentId
          data: requestBody.data
      - text: Start a match-some run on segment {segmentId} without waiting, instant {instant}.
        slots:
          segmentId: path.segmentId
          instant: query.instant
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/3/segmentMatchSome/{segmentId}/{runId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the results of a match-some run
      effect: read
      questions:
      - Where do I collect the results of a match-some request?
      - Is my match-some run ready yet?
      instructions:
      - text: Get match-some results for run {runId} on segment {segmentId}.
        slots:
          runId: path.runId
          segmentId: path.segmentId
      - text: Fetch page {page} of the match-some run {runId} for segment {segmentId}.
        slots:
          page: query.page
          runId: path.runId
          segmentId: path.segmentId
      method: generated
      generated: '2026-09-26'