Iterable Campaigns API
Create, retrieve, and manage marketing campaigns. Access campaign metrics and trigger campaign sends.
Iterable Campaigns API is one of 23 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 3 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.iterable.com/api, https://api.eu.iterable.com/api.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Iterable Campaigns API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Api-Key (apiKeyAuth).
By default, every request must be authenticated.
apiKeyAuth— Iterable API key passed in the Api-Key header. API keys can be created and managed in the Iterable project settings.
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Create, retrieve, and manage marketing campaigns. Access campaign metrics and trigger campaign sends.
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Campaign (10 properties), CampaignCreateRequest (6 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Iterable 12
Other APIs Iterable publishes across the network.