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

Extole Components Subscriptions API

The Components Subscriptions API from Extole — 4 operation(s) for components subscriptions.

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

Tagged areas include Components Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://{brand}.extole.io.

5 operations 4 paths 6 schemas 1 DELETE3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.extole.io
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Extole Components Subscriptions API declares 3 security schemes for authenticating requests. An API key is passed in the cookie as extole_token (COOKIE). An API key is passed in the header as Authorization (HEADER). An API key is passed in the query as access_token (QUERY). By default, every request must be authenticated.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Components Subscriptions 5
GET
/v1/component-subscriptions
List component subscriptions
listComponentSubscriptions → 200400401402403415429
POST
/v1/component-subscriptions
Subscribe to a component
subscribeComponent → 200400401402403415429
GET
/v1/component-subscriptions/built
List built component subscriptions
listBuiltComponentSubscriptions → 200400401402403415429
GET
/v1/component-subscriptions/subscribers
List component subscribers
listSubscribers → 200400401402403415429
DELETE
/v1/component-subscriptions/{subscriptionId}
Unsubscribe from a component
unsubscribeComponent 1 param → 200400401402403415429

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are BuiltComponentSubscriptionResponse (6 properties), ComponentSubscriptionResponse (6 properties), ComponentSubscriberResponse (5 properties), RestExceptionResponse (5 properties). Each schema is shown below with its type and property counts.

ComponentSubscriptionResponse
object
6 properties 6 required
ZonedDateTime
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557section-4) date-time with a num…
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
BuiltComponentSubscriptionResponse
object
6 properties 6 required
ComponentReferenceResponse
object
2 properties
ComponentSubscriberResponse
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-components-subscriptions-api-openapi.yml Raw ↑

Other APIs Extole publishes across the network.

Extole Audiences API
Extole Authentication API
Extole Batch Jobs API
Extole Blocks API
Extole Campaign Controllers Actions API
Extole Campaign Controllers API
Extole Campaign Controllers Triggers API
Extole Campaign Flow Steps API
Extole Campaigns API
Extole Components API
Extole Components Grants API
Extole Components Settings API