ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ActiveCampaign API v3 Lists API

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

$.info

$.paths['/lists'].get

$.paths['/lists'].post

$.paths['/lists/{id}'].get

$.paths['/lists/{id}'].delete

$.paths['/listGroups'].post

$.paths['/lists/exclusions/{id}'].get

$.paths['/lists/exclusions/{id}'].put

$.paths['/lists/exclusions'].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 ActiveCampaign API v3 Lists API
  version: 1.0.0
extends: openapi/activecampaign-lists-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: 8
- target: $.paths['/lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List contact lists
      effect: read
      questions:
      - Which mailing lists do I have in ActiveCampaign?
      - Can I search my lists by name and sort them alphabetically?
      instructions:
      - text: List all my contact lists.
      - text: Find lists named {name}.
        slots:
          name: query.filters[name]
      - text: Show the first {limit} lists.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contact list
      effect: write
      questions:
      - How do I create a new mailing list?
      - Can I set a list's sender details when creating it?
      instructions:
      - text: Create a list with {list}.
        slots:
          list: requestBody.list
      - text: Set up a new Customers Newsletter list.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contact list
      effect: read
      questions:
      - Where do I see the settings for one mailing list?
      - What are the details of list 2?
      instructions:
      - text: Show list {id}.
        slots:
          id: path.id
      - text: Get the sender settings of list {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contact list
      effect: destructive
      questions:
      - How do I delete a mailing list?
      - Will deleting a list remove it permanently?
      instructions:
      - text: Delete list {id}.
        slots:
          id: path.id
      - text: Remove the old list {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/listGroups'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant a user group access to a list
      effect: write
      questions:
      - Can I give a user group permission to a specific list?
      - How do I control which teams can use a list?
      instructions:
      - text: Grant list access with {listGroup}.
        slots:
          listGroup: requestBody.listGroup
      - text: Give the Sales user group permission on the Leads list.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/exclusions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a list exclusion
      effect: read
      questions:
      - Where do I see the details of one exclusion rule?
      - Which lists does exclusion 3 apply to?
      instructions:
      - text: Show exclusion {id}.
        slots:
          id: path.id
      - text: Get the lists and channel covered by exclusion {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/exclusions/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a list exclusion
      effect: write
      questions:
      - Can I change which lists an exclusion applies to?
      - Is it possible to switch an exclusion to a different channel?
      instructions:
      - text: Update exclusion {id} to cover lists {lists}.
        slots:
          id: path.id
          lists: requestBody.lists
      - text: Set exclusion {id} to channel {channel}.
        slots:
          id: path.id
          channel: requestBody.channel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/exclusions'].get
  update:
    x-apievangelist-phrasing:
      intent: List exclusions
      effect: read
      questions:
      - Which email addresses or patterns are excluded from my lists?
      - Can I search exclusions by a matching phrase?
      instructions:
      - text: List all exclusions.
      - text: Find exclusions matching {matchPhrase}.
        slots:
          matchPhrase: query.filters[matchPhrase]
      - text: Show exclusions on lists {lists}.
        slots:
          lists: query.filters[lists]
      method: generated
      generated: '2026-09-26'