ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ActiveCampaign API v3 Addresses API

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

$.info
$.paths['/addresses'].get
$.paths['/addresses'].post
$.paths['/addresses/{id}'].get
$.paths['/addresses/{id}'].put
$.paths['/addresses/{id}'].delete
$.paths['/addressGroups/{id}'].delete
$.paths['/addressLists/{id}'].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 ActiveCampaign API v3 Addresses API
  version: 1.0.0
extends: openapi/activecampaign-addresses-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: 7
- target: $.paths['/addresses'].get
  update:
    x-apievangelist-phrasing:
      intent: List mailing addresses
      effect: read
      questions:
      - Which physical sender addresses are saved in my ActiveCampaign account?
      - What postal addresses can I use in email footers?
      instructions:
      - text: List all my saved addresses.
      - text: Show every sender address on the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/addresses'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a sender address
      effect: write
      questions:
      - How do I add a new company postal address for my emails?
      - Can I save a second office address for compliance footers?
      instructions:
      - text: Create an address with {address}.
        slots:
          address: requestBody.address
      - text: Add our London office as a sender address.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/addresses/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sender address
      effect: read
      questions:
      - Where can I view one saved address by its ID?
      - What are the details of address 4?
      instructions:
      - text: Show address {id}.
        slots:
          id: path.id
      - text: Get the street and city of address {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/addresses/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a sender address
      effect: write
      questions:
      - Can I change the details of an address after our office moved?
      - Is it possible to edit a saved address?
      instructions:
      - text: Update address {id} with {address}.
        slots:
          id: path.id
          address: requestBody.address
      - text: Change the street on address {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/addresses/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sender address
      effect: destructive
      questions:
      - How do I remove an address we no longer use?
      - Can a saved sender address be deleted entirely?
      instructions:
      - text: Delete address {id}.
        slots:
          id: path.id
      - text: Remove the old office address {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/addressGroups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink an address from a user group
      effect: destructive
      questions:
      - Can I detach an address from a specific user group without deleting it?
      - What removes the association between an address and a group?
      instructions:
      - text: Delete address-group association {id}.
        slots:
          id: path.id
      - text: Unlink the address from its user group via association {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/addressLists/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink an address from a list
      effect: destructive
      questions:
      - Is it possible to stop a list from using a particular address?
      - Which call removes an address's association with a list?
      instructions:
      - text: Delete address-list association {id}.
        slots:
          id: path.id
      - text: Detach the address from its list via association {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'