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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Partners CRM Sync API
version: 1.0.0
extends: openapi/activecampaign-crm-sync-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['/api/crm-sync/v1/pipelines'].get
update:
x-apievangelist-phrasing:
intent: List pipelines with CRM sync status
effect: read
questions:
- Which of my pipelines are syncing to the external CRM?
- Can I search pipelines and sort them by sync status?
instructions:
- text: List pipelines with their CRM sync status.
- text: Find pipelines matching {search}, sorted by {sort_by}.
slots:
search: query.search
sort_by: query.sort_by
method: generated
generated: '2026-09-26'
- target: $.paths['/api/crm-sync/v1/pipelines/{pipeline_id}/sync'].get
update:
x-apievangelist-phrasing:
intent: Get a pipeline's CRM sync setup
effect: read
questions:
- Is CRM sync turned on for a particular pipeline?
- What target is one pipeline syncing to?
instructions:
- text: Show the CRM sync configuration for pipeline {pipeline_id}.
slots:
pipeline_id: path.pipeline_id
- text: Check whether pipeline {pipeline_id} is syncing.
slots:
pipeline_id: path.pipeline_id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/crm-sync/v1/pipelines/{pipeline_id}/sync'].put
update:
x-apievangelist-phrasing:
intent: Turn CRM sync on or off for a pipeline
effect: write
questions:
- How do I enable CRM sync for one pipeline?
- Can I change which target a pipeline syncs to?
instructions:
- text: Set CRM sync for pipeline {pipeline_id} to {sync_enabled}.
slots:
pipeline_id: path.pipeline_id
sync_enabled: requestBody.sync_enabled
- text: Enable sync ({sync_enabled}) on pipeline {pipeline_id} targeting {target}.
slots:
sync_enabled: requestBody.sync_enabled
pipeline_id: path.pipeline_id
target: requestBody.target
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.