ActiveCampaign · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for ActiveCampaign API v3 Other API
19 actions
19 updates
phrasing
extends
openapi/activecampaign-other-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.
What the actions change
x-apievangelist-phrasing
Targets 19 · first 16 shown; the file carries all of them
$.info
$.paths['/activities'].get
$.paths['/geoIps/{geoAddressID}/geoAddress'].get
$.paths['/emailActivities'].get
$.paths['/records/{schemdId}/external/{externalId}'].get
$.paths['/connections'].get
$.paths['/connections'].post
$.paths['/connections/{id}'].get
$.paths['/connections/{id}'].put
$.paths['/connections/{id}'].delete
$.paths['/configs/{id}'].put
$.paths['/trackingLogs/{eventId}/contact'].get
$.paths['/localevent'].post
$.paths['/stripo/personalizationTags'].get
$.paths['/stripo/config'].get
$.paths['/content/editorMarkup/{messageId}'].get
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 ActiveCampaign API v3 Other API
version: 1.0.0
extends: openapi/activecampaign-other-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: 18
- target: $.paths['/activities'].get
update:
x-apievangelist-phrasing:
intent: List a contact's recent activity
effect: read
questions:
- What has a contact been doing recently in ActiveCampaign?
- Can I see a contact's activity only after a certain date?
- Which recent actions, like email opens or clicks, did this person take?
instructions:
- text: Show recent activity for contact {contact}.
slots:
contact: query.contact
- text: List contact {contact}'s activities since {after}, newest first.
slots:
contact: query.contact
after: query.after
method: generated
generated: '2026-09-26'
- target: $.paths['/geoIps/{geoAddressID}/geoAddress'].get
update:
x-apievangelist-phrasing:
intent: Get a contact's geo IP location
effect: read
questions:
- Where is a contact located based on their IP address?
- Can I look up the geographic address behind a contact's geo IP record?
instructions:
- text: Show the geo address for geo IP record {geoAddressID}.
slots:
geoAddressID: path.geoAddressID
- text: Look up the city and country for geo address {geoAddressID}.
slots:
geoAddressID: path.geoAddressID
method: generated
generated: '2026-09-26'
- target: $.paths['/emailActivities'].get
update:
x-apievangelist-phrasing:
intent: List email activities
effect: read
questions:
- Which emails have been exchanged with a specific contact?
- Can I see the email activity logged against a deal?
instructions:
- text: List email activities for subscriber {subscriberid}.
slots:
subscriberid: query.filters[subscriberid]
- text: Show the emails logged on deal {dealId}.
slots:
dealId: query.filters[dealId]
method: generated
generated: '2026-09-26'
- target: $.paths['/records/{schemdId}/external/{externalId}'].get
update:
x-apievangelist-phrasing:
intent: Get a custom object record by external ID
effect: read
questions:
- Can I find a custom object record using the ID from my own system?
- How would I fetch a record by its external ID instead of the internal one?
instructions:
- text: Get the record with external ID {externalId} in schema {schemdId}.
slots:
externalId: path.externalId
schemdId: path.schemdId
- text: Look up custom object {schemdId} record by external key {externalId}.
slots:
schemdId: path.schemdId
externalId: path.externalId
method: generated
generated: '2026-09-26'
- target: $.paths['/connections'].get
update:
x-apievangelist-phrasing:
intent: List e-commerce store connections
effect: read
questions:
- Which stores or integrations are connected to my account for deep data?
- Can I find a connection by the service name or its external ID?
instructions:
- text: List all my integration connections.
- text: Find connections for service {service}.
slots:
service: query.filters[service]
- text: Find the connection with external ID {externalid}.
slots:
externalid: query.filters[externalid]
method: generated
generated: '2026-09-26'
- target: $.paths['/connections'].post
update:
x-apievangelist-phrasing:
intent: Create an integration connection
effect: write
questions:
- How do I connect an online store so its orders sync in?
- Can I register a new integration connection for my shop?
instructions:
- text: Create a connection with {connection}.
slots:
connection: requestBody.connection
- text: Set up a new store integration connection.
method: generated
generated: '2026-09-26'
- target: $.paths['/connections/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an integration connection
effect: read
questions:
- What service, name and status does a particular connection have?
- Can I look up one store connection by its ID?
instructions:
- text: Show connection {id}.
slots:
id: path.id
- text: Get the details of store integration {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/connections/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update an integration connection
effect: write
questions:
- Can I change the name or logo of an existing store connection?
- How do I edit a connection I already set up?
instructions:
- text: Update connection {id} with {connection}.
slots:
id: path.id
connection: requestBody.connection
- text: Edit the settings on store integration {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/connections/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an integration connection
effect: destructive
questions:
- How do I disconnect a store integration?
- What happens to a connection when I remove it?
instructions:
- text: Delete connection {id}.
slots:
id: path.id
- text: Disconnect store integration {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/configs/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update an account setting
effect: write
questions:
- Can I change an account configuration setting through the API?
- How do I update a stored config value?
instructions:
- text: Update config setting {id}.
slots:
id: path.id
- text: Change the account setting with ID {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/trackingLogs/{eventId}/contact'].get
update:
x-apievangelist-phrasing:
intent: Find the contact behind a tracked event
effect: read
questions:
- Which contact triggered a particular tracking event?
- Can I go from a tracking log event ID to the person involved?
instructions:
- text: Get the contact involved in event {eventId}.
slots:
eventId: path.eventId
- text: Identify the person behind tracking log event {eventId}.
slots:
eventId: path.eventId
method: generated
generated: '2026-09-26'
- target: $.paths['/localevent'].post
update:
x-apievangelist-phrasing:
intent: Record a local tracking event
effect: write
questions:
- How are local events from the tracking script recorded?
- Can I post a local event row directly?
instructions:
- text: Record the local event {localEvent}.
slots:
localEvent: requestBody.localEvent
- text: Submit a new local tracking event.
method: generated
generated: '2026-09-26'
- target: $.paths['/stripo/personalizationTags'].get
update:
x-apievangelist-phrasing:
intent: List email editor personalization tags
effect: read
questions:
- Which personalization tags can I insert in the email designer?
- Can I see the merge tags available for a specific campaign?
instructions:
- text: List personalization tags for campaign {campaignId}.
slots:
campaignId: query.campaignId
- text: Show the editor merge tags available in scope {scope}.
slots:
scope: query.scope
method: generated
generated: '2026-09-26'
- target: $.paths['/stripo/config'].get
update:
x-apievangelist-phrasing:
intent: Get the Stripo email editor config
effect: read
questions:
- What configuration does the Stripo email editor load for a campaign?
- Can I fetch the editor settings used when designing an email?
instructions:
- text: Get the Stripo editor config for campaign {campaignId}.
slots:
campaignId: query.campaignId
- text: Load the Stripo email editor configuration.
method: generated
generated: '2026-09-26'
- target: $.paths['/content/editorMarkup/{messageId}'].get
update:
x-apievangelist-phrasing:
intent: Get a message's editor markup
effect: read
questions:
- Can I pull the raw editor markup behind an email message?
- What HTML does the designer hold for a given message?
instructions:
- text: Get the editor markup for message {messageId}.
slots:
messageId: path.messageId
- text: Export the designer markup of message {messageId}.
slots:
messageId: path.messageId
method: generated
generated: '2026-09-26'
- target: $.paths['/prism/urlWhitelistings'].get
update:
x-apievangelist-phrasing:
intent: List site tracking whitelisted domains
effect: read
questions:
- Which domains are allowed for site tracking?
- Is my website on the site tracking whitelist?
instructions:
- text: List all domains on the site tracking whitelist.
- text: Show which websites site tracking is allowed on.
method: generated
generated: '2026-09-26'
- target: $.paths['/prism/urlWhitelistings'].post
update:
x-apievangelist-phrasing:
intent: Whitelist a domain for site tracking
effect: write
questions:
- How do I allow a new website to be tracked?
- Can I add my shop's domain to the site tracking whitelist?
instructions:
- text: Add {domain} to the site tracking whitelist.
slots:
domain: requestBody.data
- text: Whitelist domain {domain} so site tracking works there.
slots:
domain: requestBody.data
method: generated
generated: '2026-09-26'
- target: $.paths['/prism/urlWhitelistings/{domain_id}'].delete
update:
x-apievangelist-phrasing:
intent: Remove a domain from site tracking
effect: destructive
questions:
- How do I stop site tracking on a domain I whitelisted?
- Can I take a website off the tracking whitelist?
instructions:
- text: Remove whitelisted domain {domain_id} from site tracking.
slots:
domain_id: path.domain_id
- text: Un-whitelist tracking domain {domain_id}.
slots:
domain_id: path.domain_id
method: generated
generated: '2026-09-26'