ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ActiveCampaign API v3 Bulk Import API

4 actions 4 updates phrasing extends openapi/activecampaign-bulk-import-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['/import/bulk_import'].get
$.paths['/import/bulk_import'].post
$.paths['/import/info'].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 API v3 Bulk Import API
  version: 1.0.0
extends: openapi/activecampaign-bulk-import-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['/import/bulk_import'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk contact import jobs
      effect: read
      questions:
      - What bulk contact imports are running or finished in ActiveCampaign?
      - Can I see the status of all my recent imports?
      instructions:
      - text: List my bulk import jobs.
      - text: Show the status of all recent contact imports.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/import/bulk_import'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk import contacts
      effect: write
      questions:
      - How do I import hundreds of contacts in one request?
      - Can I get a callback when a bulk import finishes?
      - What is the maximum number of contacts per bulk import call?
      instructions:
      - text: 'Bulk import these contacts: {contacts}.'
        slots:
          contacts: requestBody.contacts
      - text: Import {contacts} and notify {callback} when done.
        slots:
          contacts: requestBody.contacts
          callback: requestBody.callback
      method: generated
      generated: '2026-09-26'
- target: $.paths['/import/info'].get
  update:
    x-apievangelist-phrasing:
      intent: Check one bulk import's progress
      effect: read
      questions:
      - Did a specific import batch finish successfully?
      - Where can I see progress for one batch ID?
      instructions:
      - text: Check the status of import batch {batchId}.
        slots:
          batchId: query.batchId
      - text: Report how far along bulk import {batchId} is.
        slots:
          batchId: query.batchId
      method: generated
      generated: '2026-09-26'