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

The subscriptions API from Iterable — 4 operation(s) for subscriptions.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 6 operations across 4 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.8.

Requests are made against a single base URL, https://api.iterable.com/.

6 operations 4 paths 15 schemas 2 DELETE2 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.8
Base URL
https://api.iterable.com
Authentication
API Key
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Iterable Subscriptions API declares 1 security scheme for authenticating requests. An API key is passed in the header as Api-Key (api_key). By default, every request must be authenticated.

Paths & Operations 6

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

subscriptions 6
POST
/api/subscriptions/subscribeToDoubleOptIn
Trigger a double opt-in subscription flow
subscribeSingleUserToDoubleOptIn body → 202204400401404500
PUT
/api/subscriptions/{subscriptionGroup}/{subscriptionGroupId}
Bulk subscription action on a list of users
Bulk subscription action 3 params body → 200202400401404409
DELETE
/api/subscriptions/{subscriptionGroup}/{subscriptionGroupId}/byUserId/{userId}
Unsubscribe a single user by userId
unsubscribeSingleUserByUserId 3 params → 200202400401404409
PATCH
/api/subscriptions/{subscriptionGroup}/{subscriptionGroupId}/byUserId/{userId}
Subscribe a single user by their userId
subscribeSingleUserByUserId 3 params → 200202400401404409
DELETE
/api/subscriptions/{subscriptionGroup}/{subscriptionGroupId}/user/{userEmail}
Unsubscribe a single user
unsubscribeSingleUser 3 params → 200202400401404409
PATCH
/api/subscriptions/{subscriptionGroup}/{subscriptionGroupId}/user/{userEmail}
Subscribe a single user
subscribeSingleUser 3 params → 200202400401404409

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Cookie (9 properties), Status (6 properties), DoubleOptInSubscriptionsRequest (5 properties), ErrorHttpResponse (4 properties). Each schema is shown below with its type and property counts.

ErrorHttpResponse
object
4 properties 4 required
ErrorWithStatus
object
1 property 1 required
Cookie
object
9 properties 6 required
Status
object
6 properties 4 required
Flash
object
3 properties 3 required
Session
object
3 properties 3 required
BulkSubscriptionActionRequest
object
2 properties
DoubleOptInSubscriptionsRequest
object
5 properties 1 required
JsObject
object
1 property 1 required
SameSite
object
1 property 1 required
ResponseHeader
object
3 properties 2 required
JsValue
object
IterableApiResponse
object
3 properties 2 required
HttpEntity
object
1 property 1 required
TypedMap
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

iterable-subscriptions-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 Campaigns API
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
#Subscription
← Back to I APIs
API Details
ID
iterable:iterable-subscriptions-api
Base URL
https://api.iterable.com
Docs
https://support.iterable.com/hc/en-us/articles/204780579-Iterable-API-Endpoints-and-Sample-Payloads
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-subscriptions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/iterable-subscriptions-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 Subscriptions 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.