Iterable · Schema
Iterable Campaign
A marketing campaign in Iterable that delivers messages to targeted audiences across email, push, SMS, and in-app channels. Campaigns can be blast sends to lists, triggered by events or API calls, or proof/test sends.
Cross-Channel MessagingCustomer EngagementEmailMarketing AutomationPush NotificationsSMS
Properties
| Name | Type | Description |
|---|---|---|
| id | integer | Unique campaign identifier |
| name | string | Human-readable campaign name |
| type | string | The type of campaign |
| templateId | integer | ID of the message template used by this campaign |
| createdAt | string | ISO 8601 timestamp of when the campaign was created |
| updatedAt | string | ISO 8601 timestamp of when the campaign was last modified |
| startAt | string | ISO 8601 timestamp of the scheduled start time |
| endedAt | string | ISO 8601 timestamp of when the campaign finished sending |
| messageMedium | string | The messaging channel used by this campaign |
| campaignState | string | Current state of the campaign lifecycle |
| listIds | array | IDs of lists targeted by this campaign |
| suppressionListIds | array | IDs of suppression lists to exclude from targeting |
| labels | array | Labels applied to the campaign for organization |
| workflowId | integer | ID of the workflow this campaign belongs to, if applicable |
| dataFields | object | Custom data fields for campaign-level personalization |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://schemas.api-evangelist.com/schemas/iterable/campaign.json",
"title": "Iterable Campaign",
"description": "A marketing campaign in Iterable that delivers messages to targeted audiences across email, push, SMS, and in-app channels. Campaigns can be blast sends to lists, triggered by events or API calls, or proof/test sends.",
"type": "object",
"required": ["id", "name"],
"properties": {
"id": {
"type": "integer",
"description": "Unique campaign identifier"
},
"name": {
"type": "string",
"minLength": 1,
"description": "Human-readable campaign name"
},
"type": {
"type": "string",
"enum": ["Blast", "Triggered", "Proof"],
"description": "The type of campaign"
},
"templateId": {
"type": "integer",
"description": "ID of the message template used by this campaign"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 timestamp of when the campaign was created"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 timestamp of when the campaign was last modified"
},
"startAt": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 timestamp of the scheduled start time"
},
"endedAt": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 timestamp of when the campaign finished sending"
},
"messageMedium": {
"type": "string",
"enum": ["Email", "Push", "SMS", "InApp", "WebPush"],
"description": "The messaging channel used by this campaign"
},
"campaignState": {
"type": "string",
"enum": ["Draft", "Scheduled", "Running", "Finished", "Cancelled"],
"description": "Current state of the campaign lifecycle"
},
"listIds": {
"type": "array",
"description": "IDs of lists targeted by this campaign",
"items": {
"type": "integer"
}
},
"suppressionListIds": {
"type": "array",
"description": "IDs of suppression lists to exclude from targeting",
"items": {
"type": "integer"
}
},
"labels": {
"type": "array",
"description": "Labels applied to the campaign for organization",
"items": {
"type": "string"
}
},
"workflowId": {
"type": "integer",
"description": "ID of the workflow this campaign belongs to, if applicable"
},
"dataFields": {
"type": "object",
"description": "Custom data fields for campaign-level personalization",
"additionalProperties": true
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/iterable-campaign"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.