ARTICLE DETAIL

资讯详情

深耕郑州网站建设与运营推广的一线实战洞察。

ActiveCampaign 集成实战指南:面向 AI Agent 的 REST API v3 操作手册

ActiveCampaign 集成实战指南:面向 AI Agent 的 REST API v3 操作手册 AI 技能人工智能【免费下载链接】marketingskillsMarketing skills for Claude Code and AI agents. CRO, copywriting, SEO, analytics, and growth engineering.项目地址https://gitcode.com/GitHub_Trending/mar/marketingskills点击查看免费下载ActiveCampaign 是集 Email 营销自动化、CRM、联系人管理、销售管道Deals Pipeline、标签体系、自动化流程与邮件活动管理于一体的平台。本文基于 marketingskills 仓库中的 ActiveCampaign 集成指南 展开结合其配套的零依赖 CLI 实现与工具注册表系统讲解 API Token 认证、REST API v3 常用操作、关键指标字段、参数取值、限流策略以及 AI Agent 如何通过 CLI 或直接调用 API 完成联系人同步、列表订阅、自动化触发、交易管道推进等实战任务。读完本文你将掌握一套可直接复制运行的 ActiveCampaign 自动化操作命令集并理解其 API 设计规律与底层实现。能力总览ActiveCampaign 在仓库的工具注册表REGISTRY.md中被归类为Email/CRM类别。根据集成指南中的 Capabilities 表其程序化接入能力如下集成方式可用性说明API✓REST API v3覆盖 contacts、deals、automations、campaigns、tags 等资源MCP-原生 MCP 不可用CLI✓仓库提供 activecampaign.js 零依赖 CLISDK✓官方提供 Python、PHP、Node.js、Ruby 语言 SDK其中原生 MCP 虽不可用但仓库的 composio 工具映射 显示可通过 Composio 为 ActiveCampaign 补充 MCP 访问能力contacts、automations 等资源适合需要以 MCP 协议接入的 Agent 场景。认证方式API TokenActiveCampaign 使用API Token认证要点如下请求头Api-Token: {api_token}Base URLhttps://{yourAccountName}.api-us1.com/api/3获取位置账户后台 Settings Developer 选项卡注意事项每个用户拥有独立的 API KeyBase URL 也是账户特有的同样在 Settings Developer 中查看由于 Base URL 是账户专属的且不同用户 Key 不同正确做法是把凭证放入环境变量由 Agent 在运行时读取避免硬编码。仓库配套 CLI 正是遵循这一约定export ACTIVECAMPAIGN_API_KEYyour_api_token export ACTIVECAMPAIGN_API_URLhttps://yourname.api-us1.com在 activecampaign.js 的源码中CLI 启动时会校验这两个环境变量缺失即报错退出并提示ACTIVECAMPAIGN_API_KEY environment variable required/ACTIVECAMPAIGN_API_URL environment variable required。这符合仓库 CLIs 安全规范密钥只从环境变量读取绝不写进脚本或仓库。安装与使用零依赖 CLICLI 安装方式仓库 tools/clis/README.md 说明所有 CLI 均为零依赖、单文件的 Node.js 脚本要求 Node 18无需npm install直接运行即可# 方式一直接运行 node tools/clis/activecampaign.js contacts list --limit 20 # 方式二全局符号链接 ln -sf $(pwd)/tools/clis/activecampaign.js ~/.local/bin/activecampaign activecampaign users me # 方式三将整个目录加入 PATH export PATH$PATH:/path/to/marketingskills/tools/clis命令模式与输出所有 CLI 遵循统一命令结构{tool} resource action [options]ActiveCampaign CLI 支持的命令族为资源子命令contactslist、get、create、update、delete、synclistslist、get、create、delete、subscribe、unsubscribecampaignslist、getdealslist、get、create、update、deleteautomationslist、get、add-contacttagslist、get、create、delete、add-to-contact、remove-from-contactpipelineslist、getwebhookslist、get、create、deleteusersme、list输出统一为 JSON 到 stdout便于jq管道处理或写入文件参见 tools/clis/README.mdnode tools/clis/activecampaign.js contacts list --limit 20 | jq .contacts[].emailCLI 还支持--limit/--offset分页参数默认 limit20、offset0见 activecampaign.js以及关键的--dry-run预览模式只打印将发送的请求含方法、URL、脱敏为***的请求头、body而不真正发起网络调用适合 Agent 在执行危险写操作前自检。环境变量安全规范仓库的 CLI 认证表tools/clis/README.md明确 ActiveCampaign 使用两个环境变量ACTIVECAMPAIGN_API_KEY与ACTIVECAMPAIGN_API_URL。安全要点密钥存于 shell 配置文件~/.zshrc、~/.bashrc或.env文件.env已被 gitignore但提交前仍需二次确认对任何命令先加--dry-run预览请求切勿在脚本或提交记录中硬编码密钥。联系人管理Contacts获取当前用户GET https://{account}.api-us1.com/api/3/users/meCLI 对应activecampaign users me。查询联系人列表# 分页查询 GET https://{account}.api-us1.com/api/3/contacts?limit20offset0 # 按邮箱精确过滤 GET https://{account}.api-us1.com/api/3/contacts?emailuserexample.com # 按姓名文本搜索 GET https://{account}.api-us1.com/api/3/contacts?searchJaneCLI 的contacts list在 activecampaign.js 中会把--email、--search、--list-id、--status等参数拼接到查询串上其中--list-id映射为listid、--status映射为status。创建联系人POST https://{account}.api-us1.com/api/3/contacts { contact: { email: userexample.com, firstName: Jane, lastName: Doe, phone: 15551234567 } }CLIactivecampaign contacts create --email userexample.com --first-name Jane --last-name Doe --phone 15551234567--email为必填见 activecampaign.js。更新联系人PUT https://{account}.api-us1.com/api/3/contacts/{contactId} { contact: { firstName: Updated, lastName: Name } }CLIactivecampaign contacts update --id 123 --first-name Updated --last-name Name。同步联系人创建或更新幂等POST https://{account}.api-us1.com/api/3/contact/sync { contact: { email: userexample.com, firstName: Jane, lastName: Doe } }这是 Agent 做数据同步时的首选端点以 email 为唯一键存在则更新、不存在则创建天然幂等。CLIactivecampaign contacts sync --email userexample.com --first-name Jane --last-name Doe。删除联系人DELETE https://{account}.api-us1.com/api/3/contacts/{contactId}CLIactivecampaign contacts delete --id 123。列表管理Lists与订阅状态查询列表GET https://{account}.api-us1.com/api/3/lists?limit20offset0CLIactivecampaign lists list或按 ID 查询activecampaign lists get --id 1。创建列表POST https://{account}.api-us1.com/api/3/lists { list: { name: Newsletter, stringid: newsletter, sender_url: https://example.com, sender_reminder: You signed up for our newsletter. } }CLIactivecampaign lists create --name Newsletter --string-id newsletter --sender-url https://example.com --sender-reminder You signed up for our newsletter.--name必填。订阅 / 退订联系人订阅与退订共用 junction 端点/contactLists通过status字段区分# 订阅status: 1 POST https://{account}.api-us1.com/api/3/contactLists { contactList: { list: 1, contact: 1, status: 1 } } # 退订status: 2 POST https://{account}.api-us1.com/api/3/contactLists { contactList: { list: 1, contact: 1, status: 2 } }CLI 对应子命令activecampaign lists subscribe --list-id 1 --contact-id 1与activecampaign lists unsubscribe --list-id 1 --contact-id 1。源码中订阅硬编码status: 1、退订硬编码status: 2见 activecampaign.js与集成指南的 Contact List Status 参数表一致。Contact List Status 取值集成指南参数表值含义1Subscribed活跃订阅2Unsubscribed已退订邮件活动Campaigns# 分页列出邮件活动 GET https://{account}.api-us1.com/api/3/campaigns?limit20offset0CLIactivecampaign campaigns list/activecampaign campaigns get --id 1。Campaign 关键指标字段集成指南 Key Metrics字段含义sends总发送数opens打开数clicks点击数uniqueopens独立打开数uniquelinks独立点击数交易管道Deals / CRM查询交易# 分页列出 GET https://{account}.api-us1.com/api/3/deals?limit20offset0 # 按管道阶段过滤 GET https://{account}.api-us1.com/api/3/deals?filters[stage]1 # 按负责人过滤 GET https://{account}.api-us1.com/api/3/deals?filters[owner]1CLI 的deals list支持--search、--stage映射为filters[stage]、--owner映射为filters[owner]见 activecampaign.js。创建交易POST https://{account}.api-us1.com/api/3/deals { deal: { title: New Enterprise Deal, value: 50000, currency: usd, group: 1, stage: 1, owner: 1, contact: 1 } }CLIactivecampaign deals create --title New Enterprise Deal --value 50000 --currency usd --pipeline 1 --stage 1 --owner 1 --contact-id 1--title必填--pipeline映射为deal.group见 activecampaign.js。更新交易推进阶段 / 调整金额PUT https://{account}.api-us1.com/api/3/deals/{dealId} { deal: { stage: 2, value: 75000 } }CLIactivecampaign deals update --id 1 --stage 2 --value 75000。注意更新子命令还支持--status内部通过Number()转为整数activecampaign.js对应 Deal Status 枚举。Deal 关键字段集成指南 Key Metrics字段含义title交易名称value交易金额以分计currency货币代码stage管道阶段 IDgroup管道deal groupIDowner负责人用户 IDstatus0开放、1赢单、2输单Deal Status 取值集成指南参数表值含义0Open开放1Won赢单2Lost输单管道Deal Groups / PipelinesGET https://{account}.api-us1.com/api/3/dealGroups?limit20offset0CLIactivecampaign pipelines list其实现正是请求/dealGroups端点activecampaign.js。自动化Automations查询自动化流程GET https://{account}.api-us1.com/api/3/automations?limit20offset0CLIactivecampaign automations list。将联系人加入自动化流程POST https://{account}.api-us1.com/api/3/contactAutomations { contactAutomation: { contact: 1, automation: 1 } }CLIactivecampaign automations add-contact --id 1 --contact-id 1。注意源码明确提示--contact-id需要的是联系人 ID 而非邮箱activecampaign.js这是 Agent 集成时最容易踩的坑——应先用contacts list --email查出 ID 再传入。标签体系Tags查询标签GET https://{account}.api-us1.com/api/3/tags?limit20offset0CLIactivecampaign tags list [--search 关键词]。创建标签POST https://{account}.api-us1.com/api/3/tags { tag: { tag: VIP Customer, tagType: contact } }CLIactivecampaign tags create --name VIP Customer --type contact--type默认contact见 activecampaign.js。给联系人打标签POST https://{account}.api-us1.com/api/3/contactTags { contactTag: { contact: 1, tag: 1 } }CLIactivecampaign tags add-to-contact --tag-id 1 --contact-id 1移除则用tags remove-from-contact --id {contactTagId}注意此时传的是 contactTag 关联记录 ID。Tag Types 取值集成指南参数表值含义contact联系人标签deal交易标签Webhook 与外部事件驱动查询 WebhookGET https://{account}.api-us1.com/api/3/webhooks?limit20offset0创建 WebhookPOST https://{account}.api-us1.com/api/3/webhooks { webhook: { name: Contact Updated, url: https://example.com/webhook, events: [subscribe, unsubscribe], sources: [public, admin, api, system] } }CLIactivecampaign webhooks create --name Contact Updated --url https://example.com/webhook --events subscribe,unsubscribe --sources public,admin,api,system。源码中--events与--sources使用逗号分隔并split(,)解析默认事件为subscribe、默认来源为[public,admin,api,system]activecampaign.js。Webhook 是基于外部事件触发自动化的关键机制Agent 可以在自有后端注册回调订阅subscribe、unsubscribe等事件实现与 ActiveCampaign 的双向联动。API 设计规律集成指南的 API Pattern 一节总结了 ActiveCampaign REST API v3 的四个核心规律理解它们能让 Agent 举一反三资源包裹Resource Wrapping所有写操作的请求体都包裹在资源对象内如{ contact: {...} }、{ deal: {...} }响应结构响应包含资源对象本身 元数据Junction 端点关联资源通过连接端点管理如/contactLists联系人↔列表、/contactTags联系人↔标签、/contactAutomations联系人↔自动化。凡是两个资源之间的关系几乎都走这类端点Base URL 账户专属 limit/offset分页所有列表端点统一使用limit默认 20与offset分页参数。常见查询参数集成指南参数表参数作用limit每页结果数默认 20offset跳过的结果数search文本搜索email按邮箱过滤联系人filters[stage]按阶段过滤交易filters[owner]按负责人过滤交易这套规律在 CLI 源码中体现得极为一致api()封装函数统一处理请求头Api-Token、Content-Type: application/json、Accept: application/json与 JSON 序列化/解析非 JSON 响应会回退为{ status, body }activecampaign.js。限流策略集成指南明确列出限流规则Agent 编排批量任务时必须遵守每账户每秒 5 个请求限流作用于同一账户下的所有 API 用户即多用户共享配额触发 429 响应时响应头携带Retry-After应据此退避重试。这意味着批量同步、批量打标签等操作需要做限速编排例如引入节流或批量窗口否则会很快触发 429。适用场景集成指南归纳了 ActiveCampaign 的典型适用场景需要复杂条件分支的营销自动化流程带交易管道管理的 CRM基于标签与分群的联系人管理邮件活动的创建与效果追踪基于外部事件触发自动化与营销联动的B2B 销售管道追踪。在仓库中ActiveCampaign 被 revops 技能 列为面向中小企业的营销自动化与潜在客户评分工具其集成指南也关联了emails、lifecycle-marketing、crm-integration、sales-pipeline、marketing-automation等技能方向——Agent 在规划邮件序列、生命周期营销或销售管道相关任务时可直接参考 emails 技能 的序列设计方法论再通过本文的 API/CLI 操作落地执行。实战组合示例结合上述全部操作一个典型的 Agent 工作流可以这样编排# 1. 幂等同步联系人 activecampaign contacts sync --email janeexample.com --first-name Jane --last-name Doe # 2. 查询联系人 ID供后续命令使用 CONTACT_ID$(activecampaign contacts list --email janeexample.com | jq -r .contacts[0].id) # 3. 订阅到 Newsletter 列表 activecampaign lists subscribe --list-id 1 --contact-id $CONTACT_ID # 4. 打上 VIP 标签 TAG_ID$(activecampaign tags list --search VIP | jq -r .tags[0].id) activecampaign tags add-to-contact --tag-id $TAG_ID --contact-id $CONTACT_ID # 5. 加入自动化流程 activecampaign automations add-contact --id 1 --contact-id $CONTACT_ID # 6. 创建一条交易并推进阶段 activecampaign deals create --title New Enterprise Deal --value 50000 --currency usd --pipeline 1 --stage 1 --owner 1 --contact-id $CONTACT_ID activecampaign deals update --id 1 --stage 2 --value 75000执行前可使用--dry-run逐条预览请求确认无误后再真正发起调用。整个过程中联系人生命周期、订阅状态、标签分群、自动化触发与销售管道推进全部通过统一认证、统一 CLI 语法完成非常适合作为 AI Agent 的自动化脚本沉淀。相关文件索引集成指南本文主体所依据的完整操作手册CLI 实现零依赖 Node.js CLI全部命令的源码依据CLI 使用说明安装方式、环境变量认证表、命令模式与输出规范工具注册表ActiveCampaign 在仓库工具索引中的条目Email/CRM 类别Composio 工具映射为 ActiveCampaign 补充 MCP 访问能力的途径revops 技能将 ActiveCampaign 用于营销自动化与潜在客户评分的场景说明赞分享AI 技能人工智能【免费下载链接】marketingskillsMarketing skills for Claude Code and AI agents. CRO, copywriting, SEO, analytics, and growth engineering.项目地址https://gitcode.com/GitHub_Trending/mar/marketingskills点击查看免费下载相关推荐vLLM-Omni 扩散模型并行策略完全指南TP / SP / CFG / HSDP / VAE Patch 的选型与落地实现vLLM Omni 扩散模型并行策略完全指南TP / SP / CFG / HSDP / VAE Patch 的选型与落地实现 导读 本文以 vLLM OmnAI 技能人工智能逆向工程的艺术如何用Python破解Beyond Compare 5的授权机制逆向工程的艺术如何用Python破解Beyond Compare 5的授权机制 当软件授权验证成为技术探索的最后一公里逆向工程便成为了开发者手中的魔法钥匙?AI 技能人工智能NetBox REST API 实战指南从认证鉴权到分页与批量操作的系统集成手册NetBox REST API 实战指南从认证鉴权到分页与批量操作的系统集成手册 NetBox 将自身打造成网络自动化生态的单一事实来源source o后端网络数据建模上一篇Android Studio中文界面终极配置指南3步实现全中文开发环境下一篇WPS-Zotero终极指南5分钟实现跨平台文献管理无缝对接创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表