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 Broadcasts API

The Broadcasts API from ActiveCampaign — 11 operation(s) for broadcasts.

ActiveCampaign Broadcasts 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 Broadcasts. 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 16 operations across 11 paths, and defines 17 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.

16 operations 11 paths 17 schemas 1 DELETE7 GET6 POST2 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 Broadcasts 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 16

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

Broadcasts 16
GET
/sms/broadcasts
ActiveCampaign Get All Broadcast Messages
listBroadcasts 8 params → 200403
POST
/sms/broadcasts
ActiveCampaign Create a New Broadcast Message
createBroadcast body → 201400403
GET
/sms/broadcasts/{id}
ActiveCampaign Get Broadcast Message
getBroadcast 1 param → 200403404
PUT
/sms/broadcasts/{id}
ActiveCampaign Update Broadcast Message
updateBroadcast 1 param body → 200403404
DELETE
/sms/broadcasts/{id}
ActiveCampaign Delete Broadcast Message
deleteBroadcast 1 param → 200403404
GET
/sms/lists
ActiveCampaign Get All Broadcast Lists
listBroadcastLists 3 params → 200
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
POST
/sms/broadcasts/metrics
ActiveCampaign Get All Broadcast Metrics
getBroadcastMetrics 2 params body → 200
GET
/sms/broadcasts/metrics/snapshot
ActiveCampaign Get Broadcast Snapshot
getBroadcastSnapshot 2 params → 200
POST
/sms/broadcasts/metrics/snapshot
ActiveCampaign Get Broadcast Snapshot
getBroadcastSnapshotByIds body → 200
GET
/sms/broadcasts/metrics/{broadcastId}/failures
ActiveCampaign Get Broadcast Failure Details
getBroadcastFailures 3 params → 200
GET
/sms/broadcasts/{broadcastId}/recipients
ActiveCampaign Get Broadcast Recipients
getBroadcastRecipients 9 params → 200
POST
/sms/broadcasts/export
ActiveCampaign Export Broadcast Metrics
exportBroadcastMetrics body → 200
POST
/sms/broadcasts/{broadcastId}/recipients/export
ActiveCampaign Export Broadcast Recipients
exportBroadcastRecipients 1 param body → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are BroadcastMessage (25 properties), BroadcastUpdateRequest (14 properties), BroadcastCreateRequest (13 properties), Recipient (9 properties). Each schema is shown below with its type and property counts.

FailureDetail
object
3 properties
BroadcastMessage
object
25 properties
BroadcastUpdateRequest
object
14 properties
AIBroadcastRequest
object
3 properties 3 required
AIBroadcastUpdateRequest
object
4 properties 4 required
RecipientsResponse
object
2 properties
BroadcastCreateRequest
object
13 properties 2 required
BroadcastMetricsResponse
object
1 property
AIBroadcastStatus
object
3 properties
AIBroadcastResponse
object
1 property
BroadcastListsResponse
object
2 properties
BroadcastList
object
3 properties
BroadcastListResponse
object
2 properties
FailureDetailsResponse
object
1 property
SnapshotResponse
object
1 property
BroadcastMetrics
object
7 properties
Recipient
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activecampaign-broadcasts-api-openapi.yml Raw ↑

Other APIs ActiveCampaign publishes across the network.

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