ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ActiveCampaign API v3 Personalizations API

9 actions 9 updates phrasing extends openapi/activecampaign-personalizations-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 9

$.info
$.paths['/personalizations'].get
$.paths['/personalizations'].post
$.paths['/personalizations/{variableID}'].get
$.paths['/personalizations/{variableID}'].put
$.paths['/personalizations/{variableID}'].delete
$.paths['/personalizations/bulkdelete'].delete
$.paths['/personalizations/{variableID}/lock'].patch
$.paths['/personalizations/{variableID}/unlock'].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 ActiveCampaign API v3 Personalizations API
  version: 1.0.0
extends: openapi/activecampaign-personalizations-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: 8
- target: $.paths['/personalizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List personalization variables
      effect: read
      questions:
      - What personalization variables can I use in my ActiveCampaign emails?
      - Can I filter personalization variables by name, tag or format?
      - How do I list only the HTML-format variables for a certain list?
      instructions:
      - text: List my personalization variables.
      - text: List personalization variables named {name} in {format} format.
        slots:
          name: query.filter[name]
          format: query.filter[format]
      - text: Show up to {limit} variables for the list named {listName}.
        slots:
          limit: query.limit
          listName: query.filter[listName]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/personalizations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a personalization variable
      effect: write
      questions:
      - How do I create a reusable personalization variable for email content?
      - Can I add a new merge variable with my own content?
      instructions:
      - text: 'Create a personalization variable: {personalization}.'
        slots:
          personalization: requestBody.personalization
      - text: Add a new variable holding our standard footer text.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/personalizations/{variableID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a personalization variable
      effect: read
      questions:
      - How do I see the content of one personalization variable?
      - Can I fetch a single variable by its ID?
      instructions:
      - text: Get personalization variable {variableID}.
        slots:
          variableID: path.variableID
      - text: Show the content of variable {variableID}.
        slots:
          variableID: path.variableID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/personalizations/{variableID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a personalization variable
      effect: write
      questions:
      - How do I change the content of a personalization variable I already made?
      - Can I rename an existing variable?
      instructions:
      - text: Edit variable {variableID} with {personalization}.
        slots:
          variableID: path.variableID
          personalization: requestBody.personalization
      - text: Change the content of personalization variable {variableID}.
        slots:
          variableID: path.variableID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/personalizations/{variableID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a personalization variable
      effect: destructive
      questions:
      - How do I delete a single personalization variable?
      - Can I remove one variable by ID?
      instructions:
      - text: Delete personalization variable {variableID}.
        slots:
          variableID: path.variableID
      - text: Remove variable {variableID}.
        slots:
          variableID: path.variableID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/personalizations/bulkdelete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several personalization variables at once
      effect: destructive
      questions:
      - Can I delete many personalization variables in one call?
      - How do I clean up a batch of old variables by their IDs?
      instructions:
      - text: Bulk delete personalization variables {ids}.
        slots:
          ids: query.ids
      - text: 'Delete all of these variables in one go: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/personalizations/{variableID}/lock'].patch
  update:
    x-apievangelist-phrasing:
      intent: Lock a personalization variable
      effect: write
      questions:
      - How do I lock a personalization variable so it can't be edited?
      - Can I protect a variable from changes?
      instructions:
      - text: Lock personalization variable {variableID}.
        slots:
          variableID: path.variableID
      - text: Protect variable {variableID} from edits by locking it.
        slots:
          variableID: path.variableID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/personalizations/{variableID}/unlock'].patch
  update:
    x-apievangelist-phrasing:
      intent: Unlock a personalization variable
      effect: write
      questions:
      - How do I unlock a locked personalization variable?
      - Can I make a locked variable editable again?
      instructions:
      - text: Unlock personalization variable {variableID}.
        slots:
          variableID: path.variableID
      - text: Make locked variable {variableID} editable again.
        slots:
          variableID: path.variableID
      method: generated
      generated: '2026-09-26'