ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ActiveCampaign API v3 Messages API

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

$.info
$.paths['/messages'].get
$.paths['/messages'].post
$.paths['/messages/{id}'].get
$.paths['/messages/{id}'].put
$.paths['/messages/{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 Messages API
  version: 1.0.0
extends: openapi/activecampaign-messages-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: 5
- target: $.paths['/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: List email messages
      effect: read
      questions:
      - Which email messages exist in my ActiveCampaign account?
      - Can I see all the message content used by my campaigns?
      instructions:
      - text: List all email messages.
      - text: Show every message I have created.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email message
      effect: write
      questions:
      - How do I create a new email message with a subject and body?
      - Can I set the from name and reply-to address on a new message?
      instructions:
      - text: Create a message with {message}.
        slots:
          message: requestBody.message
      - text: Draft a new email message.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/messages/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email message
      effect: read
      questions:
      - What subject and content does a particular message have?
      - Can I fetch a single email message by ID?
      instructions:
      - text: Show message {id}.
        slots:
          id: path.id
      - text: Get the subject and body of message {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/messages/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an email message
      effect: write
      questions:
      - Can I change the subject line of an existing message?
      - How do I edit the content of a message I already created?
      instructions:
      - text: Update message {id} with {message}.
        slots:
          id: path.id
          message: requestBody.message
      - text: Edit the content of existing message {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/messages/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email message
      effect: destructive
      questions:
      - How do I remove an email message I no longer need?
      - Can I delete a single message by its ID?
      instructions:
      - text: Delete message {id}.
        slots:
          id: path.id
      - text: Remove email message {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'