ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partners AI Customization Instructions API

6 actions 6 updates phrasing extends openapi/activecampaign-ai-customization-instructions-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['/api/ai-customizations/v1/profiles/{profile_id}/instructions'].get

$.paths['/api/ai-customizations/v1/profiles/{profile_id}/instructions'].post

$.paths['/api/ai-customizations/v1/profiles/{profile_id}/instructions/{instruction_id}'].get

$.paths['/api/ai-customizations/v1/profiles/{profile_id}/instructions/{instruction_id}'].delete

$.paths['/api/ai-customizations/v1/profiles/{profile_id}/instructions/{instruction_id}'].patch

OpenAPI Overlay

# 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 Instructions API
  version: 1.0.0
extends: openapi/activecampaign-ai-customization-instructions-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['/api/ai-customizations/v1/profiles/{profile_id}/instructions'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom AI instructions for a profile
      effect: read
      questions:
      - What custom instructions guide the AI for a given customization profile?
      - Can I see every AI instruction attached to one profile?
      instructions:
      - text: List the custom AI instructions for profile {profile_id}.
        slots:
          profile_id: path.profile_id
      - text: Show all instructions on AI profile {profile_id}.
        slots:
          profile_id: path.profile_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-customizations/v1/profiles/{profile_id}/instructions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a custom AI instruction
      effect: write
      questions:
      - How do I tell the AI to always write in a certain tone?
      - Can I add a new instruction to an AI profile but keep it disabled for now?
      instructions:
      - text: Add the instruction {custom_instruction} to AI profile {profile_id}.
        slots:
          custom_instruction: requestBody.custom_instruction
          profile_id: path.profile_id
      - text: Create instruction {custom_instruction} on profile {profile_id} with enabled set to {is_enabled}.
        slots:
          custom_instruction: requestBody.custom_instruction
          profile_id: path.profile_id
          is_enabled: requestBody.is_enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-customizations/v1/profiles/{profile_id}/instructions/{instruction_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom AI instruction
      effect: read
      questions:
      - What does a specific AI instruction say and is it enabled?
      - Can I fetch a single custom instruction by its ID?
      instructions:
      - text: Show instruction {instruction_id} on AI profile {profile_id}.
        slots:
          instruction_id: path.instruction_id
          profile_id: path.profile_id
      - text: Get custom AI instruction {instruction_id} from profile {profile_id}.
        slots:
          instruction_id: path.instruction_id
          profile_id: path.profile_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-customizations/v1/profiles/{profile_id}/instructions/{instruction_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom AI instruction
      effect: destructive
      questions:
      - How do I remove an AI instruction I no longer want applied?
      - Can I permanently delete one custom instruction from a profile?
      instructions:
      - text: Delete instruction {instruction_id} from AI profile {profile_id}.
        slots:
          instruction_id: path.instruction_id
          profile_id: path.profile_id
      - text: Remove custom AI instruction {instruction_id} on profile {profile_id}.
        slots:
          instruction_id: path.instruction_id
          profile_id: path.profile_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ai-customizations/v1/profiles/{profile_id}/instructions/{instruction_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit or toggle a custom AI instruction
      effect: write
      questions:
      - Can I turn off an AI instruction without deleting it?
      - How do I reword an existing custom instruction?
      instructions:
      - text: Change instruction {instruction_id} on profile {profile_id} to {custom_instruction}.
        slots:
          instruction_id: path.instruction_id
          profile_id: path.profile_id
          custom_instruction: requestBody.custom_instruction
      - text: Set instruction {instruction_id} on AI profile {profile_id} enabled to {is_enabled}.
        slots:
          instruction_id: path.instruction_id
          profile_id: path.profile_id
          is_enabled: requestBody.is_enabled
      method: generated
      generated: '2026-09-26'