ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ActiveCampaign SMS Broadcast AI API

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

$.info
$.paths['/sms/broadcasts/ai'].put
$.paths['/sms/broadcasts/ai'].post
$.paths['/sms/broadcasts/ai/{Id}'].get

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 SMS Broadcast AI API
  version: 1.0.0
extends: openapi/activecampaign-ai-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: 3
- target: $.paths['/sms/broadcasts/ai'].put
  update:
    x-apievangelist-phrasing:
      intent: Rewrite an SMS broadcast with AI
      effect: write
      questions:
      - Can AI rewrite an SMS broadcast I already created?
      - How do I change the tone of an existing text broadcast using a prompt?
      instructions:
      - text: Rewrite broadcast {broadcastId} with prompt {prompt} in a {tone} tone from {source}.
        slots:
          broadcastId: requestBody.broadcastId
          prompt: requestBody.prompt
          tone: requestBody.tone
          source: requestBody.source
      - text: 'Use AI on broadcast {broadcastId}: {prompt}, tone {tone}, source {source}.'
        slots:
          broadcastId: requestBody.broadcastId
          prompt: requestBody.prompt
          tone: requestBody.tone
          source: requestBody.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms/broadcasts/ai'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a new SMS broadcast with AI
      effect: write
      questions:
      - Can AI draft a new SMS broadcast from a short prompt?
      - Which tones can I pick when generating a text campaign with AI?
      instructions:
      - text: Generate an SMS broadcast from {prompt} in a {tone} tone via {source}.
        slots:
          prompt: requestBody.prompt
          tone: requestBody.tone
          source: requestBody.source
      - text: 'Draft a new AI text broadcast: {prompt}, tone {tone}, source {source}.'
        slots:
          prompt: requestBody.prompt
          tone: requestBody.tone
          source: requestBody.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms/broadcasts/ai/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an AI broadcast request's status
      effect: read
      questions:
      - Is my AI-generated SMS broadcast ready yet?
      - What is the status of an AI broadcast request?
      instructions:
      - text: Check the status of AI broadcast request {Id}.
        slots:
          Id: path.Id
      - text: Tell me whether AI request {Id} has finished generating.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-09-26'