ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Segments Match One API

3 actions 3 updates phrasing extends openapi/activecampaign-match-one-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['/segmentMatch/{segmentId}/{contactId}'].get
$.paths['/segmentMatch/{segmentId}/{contactId}/{externalId}'].get

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 Segments Match One API
  version: 1.0.0
extends: openapi/activecampaign-match-one-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['/segmentMatch/{segmentId}/{contactId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a contact is in a segment
      effect: read
      questions:
      - Does a particular contact currently match a segment?
      - Can I test one contact against a segment's conditions?
      instructions:
      - text: Check whether contact {contactId} matches segment {segmentId}.
        slots:
          contactId: path.contactId
          segmentId: path.segmentId
      - text: Test contact {contactId} against segment {segmentId}.
        slots:
          contactId: path.contactId
          segmentId: path.segmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segmentMatch/{segmentId}/{contactId}/{externalId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a segment match using an external ID
      effect: read
      questions:
      - Can I check a segment match for a contact scoped to an external ID?
      - How do I test segment membership when the contact's record has an external ID?
      instructions:
      - text: Check if contact {contactId} matches segment {segmentId} using external ID {externalId}.
        slots:
          contactId: path.contactId
          segmentId: path.segmentId
          externalId: path.externalId
      - text: Test segment {segmentId} for contact {contactId} with external ID {externalId}.
        slots:
          segmentId: path.segmentId
          contactId: path.contactId
          externalId: path.externalId
      method: generated
      generated: '2026-09-26'