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

Paubox Subscriptions API

Subscriber opt-in and opt-out operations

Paubox Subscriptions API is one of 13 APIs that Paubox 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, API documentation, a getting-started guide, and authentication docs.

This API exposes 10 operations across 8 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.paubox.com/v1/marketing.

10 operations 8 paths 17 schemas 1 DELETE2 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.paubox.com/v1/email
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Paubox Subscriptions API declares 1 security scheme for authenticating requests. An API key is passed in the header as authorization (TokenAuth). By default, every request must be authenticated.

  • TokenAuth — Token-based authentication. Use format: "Token token= " where is your API key

Paths & Operations 10

Across 8 paths, the API surfaces 10 operations — 1 DELETE, 2 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

subscriptions 10

Subscriber opt-in and opt-out operations

GET
/subscriptions
List subscriptions
getSubscriptions → 200401500
POST
/subscriptions
Create a subscription
createSubscription body → 200401500
GET
/subscriptions/{subscription_id}
Fetch a subscription
getSubscription 1 param → 200401404500
DELETE
/subscriptions/{subscription_id}
Unsubscribe a subscription
deleteSubscription 1 param → 200401404500
POST
/subscriptions/subscribe
Subscribe subscribers
subscribeSubscribers body → 200401500
POST
/subscriptions/unsubscribe
Unsubscribe subscribers
unsubscribeSubscribers body → 200401500
POST
/subscriptions/bulk_global_subscribe
Bulk global subscribe
bulkGlobalSubscribe body → 200401500
POST
/subscriptions/bulk_global_unsubscribe
Bulk global unsubscribe
bulkGlobalUnsubscribe body → 200401500
POST
/subscriptions/dynamic_bulk_subscribe
Bulk subscribe a dynamic list
dynamicBulkSubscribe body → 200401500
POST
/subscriptions/dynamic_bulk_unsubscribe
Bulk unsubscribe a dynamic list
dynamicBulkUnsubscribe body → 200401500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are DetailedSubscriber_attributes (9 properties), Subscription (9 properties), DetailedSubscriber_attributes_statistics (8 properties), BulkSubscriptionChangeRequest (5 properties). Each schema is shown below with its type and property counts.

DetailedSubscriber_attributes
object
9 properties
DetailedSubscriber
object
3 properties
SubscriptionsResponse
object
1 property
BulkSubscriptionChangeResponse
object
2 properties
SubscriptionChangeRequest
object
2 properties 1 required
SubscriptionResponse
object
1 property
Subscription
object
9 properties
CreateSubscriptionRequest
object
1 property
CreateSubscriptionResponse
object
Returned with HTTP 200 in both the success and the validation-failure case. Check for the presence of errors.
2 properties
SubscriptionChangeResponse
object
The affected subscribers in JSON:API form. Returned with HTTP 200; on failure the body carries errors instead of data.
2 properties
BulkSubscriptionChangeRequest
object
5 properties
BulkSubscriptionJob
object
1 property
Error
object
3 properties
DetailedSubscriber_attributes_custom_fields
object
3 properties
DetailedSubscriber_attributes_subscription_lists
object
3 properties
CreateSubscriptionRequest_subscription
object
2 properties 2 required
DetailedSubscriber_attributes_statistics
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paubox-subscriptions-api-openapi.yml Raw ↑

Other APIs Paubox publishes across the network.

Paubox MCP Server
Paubox Analytics API
Paubox Campaign Mailings API
Paubox Drip Campaigns API
Paubox Dynamic Templates API
Paubox Form management API
Paubox Forms API
Paubox Messages API
Paubox Submissions API
Paubox Subscribers API
Paubox Subscription Lists API
Paubox Tracking Links API
Where this information came from

This is an independent, third-party profile of Paubox 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.