Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ActiveCampaign AI API

The AI API from ActiveCampaign — 2 operation(s) for ai.

ActiveCampaign AI API is one of 36 APIs that ActiveCampaign publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 9 JSON Schema definitions.

Tagged areas include AI. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an AsyncAPI specification, and 9 JSON Schemas.

This API exposes 3 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 3.0.0.

Requests are made against a single base URL, https://{yourAccountName}.api-us1.com/api/3.

3 operations 2 paths 4 schemas 1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.0
Base URL
https://youraccountname.api-us1.com/api/3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

ActiveCampaign AI API declares 1 security scheme for authenticating requests. An API key is passed in the header as Api-Token (ApiToken). By default, every request must be authenticated.

  • ApiToken — Your ActiveCampaign API token

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

AI 3
POST
/sms/broadcasts/ai
ActiveCampaign Create AI-generated Broadcast
createAIBroadcast body → 200
PUT
/sms/broadcasts/ai
ActiveCampaign Update Broadcast with AI
updateAIBroadcast body → 200
GET
/sms/broadcasts/ai/{Id}
ActiveCampaign Get AI Broadcast Request Status
getAIBroadcastStatus 1 param → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are AIBroadcastUpdateRequest (4 properties), AIBroadcastRequest (3 properties), AIBroadcastStatus (3 properties), AIBroadcastResponse (1 property). Each schema is shown below with its type and property counts.

AIBroadcastStatus
object
3 properties
AIBroadcastUpdateRequest
object
4 properties 4 required
AIBroadcastRequest
object
3 properties 3 required
AIBroadcastResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activecampaign-ai-api-openapi.yml Raw ↑

Other APIs ActiveCampaign publishes across the network.

ActiveCampaign Accounts API
ActiveCampaign Addresses API
ActiveCampaign Automations API
ActiveCampaign Branding API
ActiveCampaign Broadcasts API
ActiveCampaign Bulk Import API
ActiveCampaign Calendars API
ActiveCampaign Campaigns API
ActiveCampaign Contacts API
ActiveCampaign Credits API
ActiveCampaign Custom Objects API
ActiveCampaign Deals API