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

beehiiv Bulk Subscription Updates API

The Bulk Subscription Updates API from beehiiv — 4 operation(s) for bulk subscription updates.

beehiiv Bulk Subscription Updates API is one of 30 APIs that beehiiv publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Bulk Subscription Updates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 2 JSON Schemas.

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

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

6 operations 4 paths 20 schemas 2 GET2 PATCH2 PUT

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.beehiiv.com/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

beehiiv Bulk Subscription Updates API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuthScheme).

Paths & Operations 6

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

Bulk Subscription Updates 6
GET
/publications/{publicationId}/bulk_subscription_updates
List subscription updates OAuth Scope: subscriptions:read
index 2 params → 200400401404429500
GET
/publications/{publicationId}/bulk_subscription_updates/{id}
Get subscription update OAuth Scope: subscriptions:read
show 3 params → 200400401404429500
PUT
/publications/{publicationId}/subscriptions/bulk_actions
Update subscriptions OAuth Scope: subscriptions:write
put 2 params body → 200400401404429500
PATCH
/publications/{publicationId}/subscriptions/bulk_actions
Update subscriptions OAuth Scope: subscriptions:write
patch 2 params body → 200400401404429500
PUT
/publications/{publicationId}/subscriptions
Update subscriptions' status OAuth Scope: subscriptions:write
put-status 2 params body → 200
PATCH
/publications/{publicationId}/subscriptions
Update subscriptions' status OAuth Scope: subscriptions:write
patch-status 2 params body → 200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesGetResponseData (10 properties), type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesListResponseDataItem (10 properties), type_bulkSubscriptionUpdates_SubscriptionsPatchRequestSubscriptionsItem (6 properties), type__Error (3 properties). Each schema is shown below with its type and property counts.

type_subscriptions_SubscriptionsPatchResponseData
object
1 property
type__Error
object
The top level error response.
3 properties 3 required
type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesListResponseDataItem
object
10 properties
type_subscriptions_SubscriptionsPatchResponse
object
1 property 1 required
type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesGetResponse
object
1 property
type_ids_OptionalStripeCustomerId
string
The prefixed ID of the Stripe customer.
type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesListResponseDataItemType
string
The type of update (status or bulk)
type_bulkSubscriptionUpdates_SubscriptionsPatchRequestSubscriptionsItemTier
string
The Tier of the Subscription (not required)
type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesListResponse
object
1 property
type__CustomFieldDataType
type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesListResponseDataItemStatus
string
The status of the update
type_bulkSubscriptionUpdates_SubscriptionsPatchRequestSubscriptionsItem
object
6 properties 1 required
type_ids_ComplimentaryAccessId
string
The prefixed ID of the complimentary access object.
type__ErrorDetail
object
2 properties 2 required
type_bulkSubscriptionUpdates_SubscriptionsPatchRequestSubscriptionsItemCustomFieldsItem
object
3 properties
type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesGetResponseDataType
string
The type of update (status or bulk)
type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesGetResponseDataStatus
string
The status of the update
type_ids_PublicationId
string
The prefixed ID of the publication.
type_ids_SubscriptionId
string
The prefixed ID of the subscription.
type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesGetResponseData
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

beehiiv-bulk-subscription-updates-api-openapi.yml Raw ↑

Other APIs beehiiv publishes across the network.

beehiiv Authorizations API
beehiiv Tokens API
beehiiv Webhooks API
beehiiv Ad Network Offers API
beehiiv Ad Network Reports API
beehiiv Advertisement Opportunities API
beehiiv Authors API
beehiiv Automation Journeys API
beehiiv Automations API
beehiiv Bulk Subscriptions API
beehiiv Complimentary Access API
beehiiv Condition Sets API
Where this information came from

This is an independent, third-party profile of beehiiv Bulk Subscription Updates 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.