ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ActiveCampaign API v3 Forms API

7 actions 7 updates phrasing extends openapi/activecampaign-forms-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['/forms/{id}'].get
$.paths['/forms/{id}'].put
$.paths['/forms/{id}'].delete
$.paths['/forms'].get
$.paths['/forms'].post
$.paths['/form/optin'].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 Forms API
  version: 1.0.0
extends: openapi/activecampaign-forms-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['/forms/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a signup form
      effect: read
      questions:
      - Where can I see the configuration of one ActiveCampaign form?
      - What does signup form 3 look like?
      instructions:
      - text: Show form {id}.
        slots:
          id: path.id
      - text: Get the settings of signup form {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forms/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a signup form
      effect: write
      questions:
      - Can I edit an existing signup form?
      - Is it possible to change a form I already built?
      instructions:
      - text: Update form {id}.
        slots:
          id: path.id
      - text: Edit the existing signup form {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forms/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a signup form
      effect: destructive
      questions:
      - How do I delete a form we no longer use?
      - Can a signup form be removed permanently?
      instructions:
      - text: Delete form {id}.
        slots:
          id: path.id
      - text: Remove the retired signup form {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forms'].get
  update:
    x-apievangelist-phrasing:
      intent: List signup forms
      effect: read
      questions:
      - Which signup forms exist in my account?
      - What forms have I built so far?
      instructions:
      - text: List all my forms.
      - text: Show every signup form on the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forms'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a signup form
      effect: write
      questions:
      - How do I create a new signup form?
      - Can I build a form through the API?
      instructions:
      - text: Create a new signup form.
      - text: Build a newsletter subscription form.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/form/optin'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a form opt-in
      effect: write
      questions:
      - Can I record a contact opting in through a form?
      - What handles the opt-in step of a form submission?
      instructions:
      - text: Submit a form opt-in.
      - text: Send an opt-in through the form opt-in endpoint.
      method: generated
      generated: '2026-09-26'