ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partners Child Accounts API

4 actions 4 updates phrasing extends openapi/activecampaign-child-accounts-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 4

$.info
$.paths['/api/child-accounts/v1/'].get
$.paths['/api/child-accounts/v1/'].post
$.paths['/api/child-accounts/v1/snapshots'].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 Partners Child Accounts API
  version: 1.0.0
extends: openapi/activecampaign-child-accounts-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: 3
- target: $.paths['/api/child-accounts/v1/'].get
  update:
    x-apievangelist-phrasing:
      intent: List child accounts
      effect: read
      questions:
      - What child accounts sit under my ActiveCampaign reseller account?
      - Can I search child accounts by name or show only archived ones?
      - How do I page through child accounts sorted a certain way?
      instructions:
      - text: List my child accounts.
      - text: Search child accounts for {search}.
        slots:
          search: query.search
      - text: List archived child accounts where archived is {is_archived}, sorted by {sort_by}.
        slots:
          is_archived: query.is_archived
          sort_by: query.sort_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/child-accounts/v1/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a child account
      effect: write
      questions:
      - How do I provision a new child account for a client?
      - Can I create a child account cloned from a snapshot?
      - What billing and country details are required to open a child account?
      instructions:
      - text: Create child account {account_name} for {name} at {email} in country {country}.
        slots:
          account_name: requestBody.account_name
          name: requestBody.name
          email: requestBody.email
          country: requestBody.country
      - text: Create child account {account_name} cloned from snapshot {snapshot_id}, billed every {billing_interval} months.
        slots:
          account_name: requestBody.account_name
          snapshot_id: requestBody.snapshot_id
          billing_interval: requestBody.billing_interval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/child-accounts/v1/snapshots'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounts eligible for snapshots
      effect: read
      questions:
      - Which of my accounts can be used as the source for a snapshot?
      - Can I search snapshot-eligible accounts by name?
      instructions:
      - text: List accounts I can take snapshots from.
      - text: Find snapshot-eligible accounts named {search}, sorted by {sort_by}.
        slots:
          search: query.search
          sort_by: query.sort_by
      method: generated
      generated: '2026-09-26'