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

The User Subscriptions API from Extole — 3 operation(s) for user subscriptions.

Extole User 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 User Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 3 paths, and defines 24 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.

6 operations 3 paths 24 schemas 1 DELETE3 GET1 POST1 PUT

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 User 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 6

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

User Subscriptions 6
GET
/v6/subscriptions
List subscriptions
listSubscriptions 2 params → 200400401402403415429
GET
/v6/users/{user_id}/subscriptions
List user subscriptions
listUserSubscriptions 1 param → 200400401402403415429
POST
/v6/users/{user_id}/subscriptions
Create a user subscription
createUserSubscription 1 param body → 200400401402403415429
GET
/v6/users/{user_id}/subscriptions/{subscription_id}
Get a user subscription
getUserSubscription 2 params → 200400401402403415429
PUT
/v6/users/{user_id}/subscriptions/{subscription_id}
Update a user subscription
updateUserSubscription 2 params body → 200400401402403415429
DELETE
/v6/users/{user_id}/subscriptions/{subscription_id}
Delete a user subscription
deleteUserSubscription 2 params → 200400401402403415429

Schemas 24

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

WebhookSubscriptionChannelRequest
object
2 required
SubscriptionUserResponse
object
4 properties
FilterExpressionInUserSubscriptionRequest
Choose between static or dynamic filter expression
EmailSubscriptionChannelRequest
object
1 required
SubscriptionChannelResponseBase
object
2 properties
SubscriptionChannelRequestBase
object
1 property
SubscriptionChannelResponse
UserSubscriptionUpdateRequest
object
Body of a PUT /v6/users/{userid}/subscriptions/{subscriptionid} request.
5 properties
WebhookSubscriptionChannelResponse
object
3 required
SlackSubscriptionChannelResponse
object
3 required
ThirdPartyEmailSubscriptionChannelResponse
object
3 required
UserSubscriptionRequest
object
5 properties 2 required
SubscriptionChannelRequest
SlackSubscriptionChannelRequest
object
2 required
UserSubscriptionResponse
object
6 properties 6 required
ExtoleClientSlackSubscriptionChannelRequest
object
1 required
ThirdPartyEmailSubscriptionChannelRequest
object
2 required
EmailSubscriptionChannelResponse
object
2 required
SuccessResponse
object
1 property 1 required
FilterExpressionInUserSubscriptionUpdateRequest
Choose between static or dynamic filter expression
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
FilterExpressionInUserSubscriptionResponse
The filter expression as configured: a literal value, or an expression (type:string) when defined dynamically.
SubscriptionResponse
object
6 properties 6 required
ExtoleClientSlackSubscriptionChannelResponse
object
2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-user-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