ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partners AI Customization Profiles API

8 actions 8 updates phrasing extends openapi/activecampaign-ai-customization-profiles-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['/api/ai-customizations/v1/profiles'].get
$.paths['/api/ai-customizations/v1/profiles'].post
$.paths['/api/ai-customizations/v1/profiles/{id}'].get
$.paths['/api/ai-customizations/v1/profiles/{id}'].delete
$.paths['/api/ai-customizations/v1/profiles/{id}'].patch
$.paths['/api/ai-customizations/v1/profiles/child-accounts/{childAccountId}'].get
$.paths['/api/ai-customizations/v1/profiles/{id}/accounts'].patch

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 Partners AI Customization Profiles API
  version: 1.0.0
extends: openapi/activecampaign-ai-customization-profiles-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['/api/ai-customizations/v1/profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List AI customization profiles
      effect: read
      questions:
      - What AI customization profiles have I set up in ActiveCampaign?
      - Can I see all the AI profiles available to assign to child accounts?
      instructions:
      - text: List my AI customization profiles.
      - text: Show every AI customization profile in the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-customizations/v1/profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an AI customization profile
      effect: write
      questions:
      - How do I create a new AI customization profile?
      - What do I need to supply to start a new AI profile?
      instructions:
      - text: Create an AI customization profile named {name}.
        slots:
          name: requestBody.name
      - text: Set up a new AI profile called {name} for our agency clients.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-customizations/v1/profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an AI customization profile
      effect: read
      questions:
      - How do I look up one AI customization profile by ID?
      - What settings does a single AI profile contain?
      instructions:
      - text: Get AI customization profile {id}.
        slots:
          id: path.id
      - text: Show the details of AI profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-customizations/v1/profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an AI customization profile
      effect: destructive
      questions:
      - How do I delete an AI customization profile I no longer use?
      - Can I remove an AI profile by its ID?
      instructions:
      - text: Delete AI customization profile {id}.
        slots:
          id: path.id
      - text: Remove AI profile {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-customizations/v1/profiles/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename an AI customization profile
      effect: write
      questions:
      - How do I rename an existing AI customization profile?
      - Can I update the name on an AI profile after creating it?
      instructions:
      - text: Rename AI customization profile {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update AI profile {id} so its name is {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-customizations/v1/profiles/child-accounts/{childAccountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the AI profile assigned to a child account
      effect: read
      questions:
      - Which AI customization profile is a given child account using?
      - Can I check a child account's assigned AI profile?
      instructions:
      - text: Get the AI profile assigned to child account {childAccountId}.
        slots:
          childAccountId: path.childAccountId
      - text: Tell me which AI customization profile child account {childAccountId} uses.
        slots:
          childAccountId: path.childAccountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-customizations/v1/profiles/{id}/accounts'].patch
  update:
    x-apievangelist-phrasing:
      intent: Assign child accounts to an AI profile
      effect: write
      questions:
      - How do I assign several child accounts to one AI customization profile?
      - Can I apply an AI profile to all of my child accounts at once?
      - Will assigning a profile move accounts that already have another profile?
      instructions:
      - text: Assign child accounts {account_ids} to AI profile {id}.
        slots:
          account_ids: requestBody.account_ids
          id: path.id
      - text: Apply AI profile {id} to every child account with assign-to-all set to {assign_to_all_accounts}.
        slots:
          id: path.id
          assign_to_all_accounts: requestBody.assign_to_all_accounts
      - text: Reassign accounts {account_ids} to profile {id} with reassign {reassign}.
        slots:
          account_ids: requestBody.account_ids
          id: path.id
          reassign: requestBody.reassign
      method: generated
      generated: '2026-09-26'