ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ActiveCampaign API v3 Campaigns API

7 actions 7 updates phrasing extends openapi/activecampaign-campaigns-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 7

$.info
$.paths['/campaigns'].get
$.paths['/campaigns/{id}/links'].get
$.paths['/campaigns/{id}'].get
$.paths['/campaigns/{id}/edit'].put
$.paths['/campaign'].post
$.paths['/campaigns/{id}/copy'].post

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 ActiveCampaign API v3 Campaigns API
  version: 1.0.0
extends: openapi/activecampaign-campaigns-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: 6
- target: $.paths['/campaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: List email campaigns
      effect: read
      questions:
      - What email campaigns have I sent from ActiveCampaign?
      - Can I list only the campaigns that belong to one automation?
      - How do I sort my campaigns by send date?
      instructions:
      - text: List all my email campaigns.
      - text: List campaigns from automation {seriesid}.
        slots:
          seriesid: query.filters[seriesid]
      - text: List campaigns ordered by send date {sdate}.
        slots:
          sdate: query.orders[sdate]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{id}/links'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the tracked links in a campaign
      effect: read
      questions:
      - Which links are included and tracked in a campaign?
      - Can I pull the list of URLs a campaign contains?
      instructions:
      - text: Get the links in campaign {id}.
        slots:
          id: path.id
      - text: Show the tracked URLs for campaign {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an email campaign
      effect: read
      questions:
      - How do I get the details and stats of one campaign?
      - Can I fetch a single campaign by its ID?
      instructions:
      - text: Get campaign {id}.
        slots:
          id: path.id
      - text: Show the details of email campaign {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{id}/edit'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a campaign's settings
      effect: write
      questions:
      - How do I change the lists or segment a campaign sends to?
      - Can I turn link tracking or read tracking on or off for an existing campaign?
      - Is there a way to reschedule a campaign's send date?
      instructions:
      - text: Rename campaign {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Point campaign {id} at lists {listIds} and schedule it for {scheduledDate}.
        slots:
          id: path.id
          listIds: requestBody.listIds
          scheduledDate: requestBody.scheduledDate
      - text: Set link tracking to {linkTrackingEnabled} on campaign {id}.
        slots:
          linkTrackingEnabled: requestBody.linkTrackingEnabled
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaign'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email campaign
      effect: write
      questions:
      - How do I create a new email campaign through the API?
      - Which campaign types can I choose when creating one?
      instructions:
      - text: Create a {type} campaign named {name}.
        slots:
          type: requestBody.type
          name: requestBody.name
      - text: Create campaign {name} of type {type} with split content set to {canSplitContent}.
        slots:
          name: requestBody.name
          type: requestBody.type
          canSplitContent: requestBody.canSplitContent
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{id}/copy'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate an existing campaign
      effect: write
      questions:
      - How do I copy an old campaign to reuse it?
      - Can I clone a campaign instead of building it from scratch?
      instructions:
      - text: Duplicate campaign {id}.
        slots:
          id: path.id
      - text: Make a copy of campaign {id} so I can edit it.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'