ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Segments Saved Segment Summaries API

3 actions 3 updates phrasing extends openapi/activecampaign-saved-segment-summaries-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for ActiveCampaign's API. It is a proposal applied on top of the contract, not a document ActiveCampaign publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/audiences'].get

$.paths['/audiences/{segmentId}'].get

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 Segments Saved Segment Summaries API
  version: 1.0.0
extends: openapi/activecampaign-saved-segment-summaries-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: 2
- target: $.paths['/audiences'].get
  update:
    x-apievangelist-phrasing:
      intent: List summaries of saved segments
      effect: read
      questions:
      - What saved segments do I have and how big is each one?
      - Can I search my saved segments by name?
      instructions:
      - text: List summaries of my saved segments.
      - text: Search saved segments for {search}, sorted by {sort}.
        slots:
          search: query.search
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{segmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one saved segment's summary
      effect: read
      questions:
      - How do I see the summary for one saved segment?
      - Can I fetch a saved segment summary by segment ID?
      instructions:
      - text: Get the summary of saved segment {segmentId}.
        slots:
          segmentId: path.segmentId
      - text: Show details for saved segment {segmentId}.
        slots:
          segmentId: path.segmentId
      method: generated
      generated: '2026-09-26'