ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partners Child Account Snapshots API

5 actions 5 updates phrasing extends openapi/activecampaign-child-account-snapshots-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 5

$.info
$.paths['/api/child-account-snapshots/v1/status'].get
$.paths['/api/child-account-snapshots/v1/'].get
$.paths['/api/child-account-snapshots/v1/'].post
$.paths['/api/child-account-snapshots/v1/{snapshotId}'].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 Partners Child Account Snapshots API
  version: 1.0.0
extends: openapi/activecampaign-child-account-snapshots-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: 4
- target: $.paths['/api/child-account-snapshots/v1/status'].get
  update:
    x-apievangelist-phrasing:
      intent: List child account cloning statuses
      effect: read
      questions:
      - Are my child account cloning jobs finished yet?
      - Can I see only the account clones that failed?
      instructions:
      - text: List child account cloning statuses.
      - text: Show cloning jobs with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/child-account-snapshots/v1/'].get
  update:
    x-apievangelist-phrasing:
      intent: List account snapshots
      effect: read
      questions:
      - Which account snapshots do I have as a reseller?
      - Can I search snapshots by name?
      instructions:
      - text: List my account snapshots.
      - text: Find snapshots named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/child-account-snapshots/v1/'].post
  update:
    x-apievangelist-phrasing:
      intent: Snapshot an account for cloning
      effect: write
      questions:
      - How do I capture an account's setup as a snapshot to reuse for child accounts?
      - Can I name a snapshot when I create it?
      instructions:
      - text: Create a snapshot named {name} of account {account_id}.
        slots:
          name: requestBody.name
          account_id: requestBody.account_id
      - text: Snapshot account {account_id} as {name}.
        slots:
          account_id: requestBody.account_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/child-account-snapshots/v1/{snapshotId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account snapshot
      effect: destructive
      questions:
      - Can I remove a snapshot I no longer need?
      - What deletes an old account template snapshot?
      instructions:
      - text: Delete snapshot {snapshotId}.
        slots:
          snapshotId: path.snapshotId
      - text: Remove the old account snapshot {snapshotId}.
        slots:
          snapshotId: path.snapshotId
      method: generated
      generated: '2026-09-26'