How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Iterable

Iterable Campaigns API

Create, retrieve, and manage marketing campaigns. Access campaign metrics and trigger campaign sends.

Documentation Provider Profile APIs.io OpenAPI GitHub

Iterable Campaigns API is one of 30 APIs that Iterable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Campaigns. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 16 operations across 16 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://api.iterable.com/, https://api.iterable.com/api, https://api.eu.iterable.com/api.

16 operations 16 paths 12 schemas 6 GET10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.iterable.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Iterable Campaigns API declares 2 security schemes for authenticating requests. An API key is passed in the header as Api-Key (api_key). An API key is passed in the header as Api-Key (apiKeyAuth).

  • apiKeyAuth — Iterable API key passed in the Api-Key header. API keys can be created and managed in the Iterable project settings.

Paths & Operations 16

Across 16 paths, the API surfaces 16 operations — 6 GET, 10 POST. Each is listed below with its method, path, parameters, and response codes.

campaigns 16
GET
/api/campaigns
List campaign metadata
campaigns 4 params → 200401
POST
/api/campaigns/abort
Abort a campaign
abort campaign body → 200400401
POST
/api/campaigns/activateTriggered
Activate a triggered campaign
activate triggered campaign body → 200400401403
POST
/api/campaigns/archive
Archive campaigns
archive campaigns body → 200400401403500
POST
/api/campaigns/cancel
Cancel a scheduled or recurring campaign
cancel campaign body → 200400401
POST
/api/campaigns/create
Create a campaign
create campaign body → 200400401
POST
/api/campaigns/deactivateTriggered
Deactivate a triggered campaign
Deactivate triggered campaign body → 200400401403
GET
/api/campaigns/metrics
Get metrics for campaigns
metrics 3 params → 200400401
GET
/api/campaigns/recurring/{id}/childCampaigns
Get child campaigns of a recurring campaign
child campaigns 5 params → 200400401
POST
/api/campaigns/trigger
Trigger a campaign
trigger campaign body → 200400401429
POST
/api/campaigns/{campaignId}/schedule
Schedule existing campaign to be sent
schedule campaign 1 param body → 200400401403
POST
/api/campaigns/{campaignId}/send
Send existing campaign now
send campaign 1 param → 200400401
GET
/api/campaigns/{id}
Get a campaign
getCampaign 1 param → 200400401404
GET
/campaigns
List campaigns
listCampaigns → 200401
POST
/campaigns/create
Create a campaign
createCampaign body → 200400401
GET
/campaigns/metrics
Get campaign metrics
getCampaignMetrics 3 params → 200401

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are CampaignDetails (19 properties), CreateCampaignRequest (12 properties), Campaign (10 properties), CampaignCreateRequest (6 properties). Each schema is shown below with its type and property counts.

CreateCampaignRequest
object
12 properties 3 required
IterableApiResponse
object
3 properties 2 required
RecipientTimeZoneRequest
object
2 properties 2 required
TriggerCampaignRequest
object
5 properties 2 required
CampaignsResponse
object
4 properties 1 required
BulkArchiveCampaignRequest
object
1 property 1 required
CampaignDetails
object
19 properties 8 required
ScheduleCampaignRequest
object
2 properties 1 required
CreateCampaignResponse
object
1 property 1 required
CampaignIdRequest
object
1 property 1 required
Campaign
object
A marketing campaign in Iterable
10 properties
CampaignCreateRequest
object
Request body for creating a new campaign
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

iterable-campaigns-api-openapi.yml Raw ↑

Other APIs Iterable publishes across the network.

Iterable Export API
AE Profile APIs.io
Iterable Web SDK
AE Profile APIs.io
Iterable iOS SDK
AE Profile APIs.io
Iterable Android SDK
AE Profile APIs.io
Iterable React Native SDK
AE Profile APIs.io
Iterable Catalogs API
AE Profile APIs.io
Iterable Channels API
AE Profile APIs.io
Iterable Commerce API
AE Profile APIs.io
Iterable Email API
AE Profile APIs.io
Iterable Events API
AE Profile APIs.io
Iterable Experiments API
AE Profile APIs.io
Iterable InApp API
AE Profile APIs.io
#Campaigns
← Back to I APIs
API Details
ID
iterable:iterable-campaigns-api
Base URL
https://api.iterable.com
Docs
https://api.iterable.com/api/docs
Provider
Iterable
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=iterable-campaigns-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/iterable-campaigns-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Iterable Campaigns API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.