beehiiv

beehiiv Bulk Subscription Updates API

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

Documentation GitHub OpenAPI

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /publications/{publicationId}/bulk_subscription_updates List bulk subscription update jobs · List subscription updates OAuth Scope: subscriptions:read #

Ask an LLM

“Where can I see the history of bulk subscriber updates I've run?”

“Which bulk subscription update jobs exist for my publication?”

Tell an agent

List bulk subscription update jobs for publication {publication}.

Show every bulk subscriber update I have run on {publication}.

GET /publications/{publicationId}/bulk_subscription_updates/{id} Check one bulk subscription update job · Get subscription update OAuth Scope: subscriptions:read #

Ask an LLM

“Did my bulk subscriber update finish successfully?”

“Can I check the progress of a single bulk update job?”

Tell an agent

Get bulk subscription update {update} for publication {publication}.

Check whether bulk update job {update} has completed.

PUT /publications/{publicationId}/subscriptions/bulk_actions Bulk update subscription fields (PUT) · Update subscriptions OAuth Scope: subscriptions:write #

Ask an LLM

“How do I change custom fields and tiers for many subscribers at once using PUT?”

“Can I send a full PUT of bulk subscription changes including status and tiers?”

Tell an agent

Use the PUT bulk action to update these subscriptions on {publication}: {subscriptions}.

Send a PUT bulk action changing status, custom fields and tiers for {subscriptions}.

PATCH /publications/{publicationId}/subscriptions/bulk_actions Bulk update subscription fields (PATCH) · Update subscriptions OAuth Scope: subscriptions:write #

Ask an LLM

“Can I PATCH custom fields and tiers across a batch of subscribers?”

“What's the PATCH way to apply bulk subscriber field changes?”

Tell an agent

PATCH bulk subscriber field changes {subscriptions} on publication {publication}.

Apply these subscriber tier and custom field changes via PATCH: {subscriptions}.

PUT /publications/{publicationId}/subscriptions Bulk set subscription status (PUT) · Update subscriptions' status OAuth Scope: subscriptions:write #

Ask an LLM

“How do I set the same status on a list of subscription IDs with a PUT request?”

“Can I mass-change subscribers to one status via PUT?”

Tell an agent

PUT status {new_status} on subscriptions {subscription_ids} in publication {publication}.

Mark subscriptions {subscription_ids} as {new_status} using the PUT status endpoint.

PATCH /publications/{publicationId}/subscriptions Bulk set subscription status (PATCH) · Update subscriptions' status OAuth Scope: subscriptions:write #

Ask an LLM

“Can I PATCH a batch of subscription IDs to a new status?”

“What's the PATCH endpoint for changing many subscribers' status at once?”

Tell an agent

PATCH subscriptions {subscription_ids} on {publication} to status {new_status}.

Switch these subscriptions to {new_status} with a PATCH: {subscription_ids}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/beehiiv:beehiiv-bulk-subscription-updates-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Reference Bulk Subscription Updates API
  version: 1.0.0
servers:
- url: https://api.beehiiv.com/v2
  description: Default
tags:
- name: Bulk Subscription Updates
paths:
  /publications/{publicationId}/bulk_subscription_updates:
    get:
      operationId: index
      summary: 'List subscription updates OAuth Scope: subscriptions:read'
      description: Returns a list of Subscription Update objects for a publication.
      tags:
      - Bulk Subscription Updates
      parameters:
      - name: publicationId
        in: path
        description: The prefixed ID of the publication object
        required: true
        schema:
          $ref: '#/components/schemas/type_ids_PublicationId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesListResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '401':
          description: Unauthorized. The API key or OAuth access token is missing, invalid, or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
  /publications/{publicationId}/bulk_subscription_updates/{id}:
    get:
      operationId: show
      summary: 'Get subscription update OAuth Scope: subscriptions:read'
      description: Returns a single Subscription Update object for a publication.
      tags:
      - Bulk Subscription Updates
      parameters:
      - name: publicationId
        in: path
        description: The prefixed ID of the publication object
        required: true
        schema:
          $ref: '#/components/schemas/type_ids_PublicationId'
      - name: id
        in: path
        description: The ID of the Subscription Update object
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesGetResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '401':
          description: Unauthorized. The API key or OAuth access token is missing, invalid, or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
  /publications/{publicationId}/subscriptions/bulk_actions:
    put:
      operationId: put
      summary: 'Update subscriptions OAuth Scope: subscriptions:write'
      description: Bulk update multiple subscriptions fields, including status, custom fields, and tiers.
      tags:
      - Bulk Subscription Updates
      parameters:
      - name: publicationId
        in: path
        description: The prefixed ID of the publication object
        required: true
        schema:
          $ref: '#/components/schemas/type_ids_PublicationId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_subscriptions_SubscriptionsPatchResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '401':
          description: Unauthorized. The API key or OAuth access token is missing, invalid, or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                subscriptions:
                  type: array
                  items:
                    $ref: '#/components/schemas/type_bulkSubscriptionUpdates_SubscriptionsPatchRequestSubscriptionsItem'
                  description: An array of objects representing the subscriptions to be updated (max 1000).
    patch:
      operationId: patch
      summary: 'Update subscriptions OAuth Scope: subscriptions:write'
      description: Bulk update multiple subscriptions fields, including status, custom fields, and tiers.
      tags:
      - Bulk Subscription Updates
      parameters:
      - name: publicationId
        in: path
        description: The prefixed ID of the publication object
        required: true
        schema:
          $ref: '#/components/schemas/type_ids_PublicationId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_subscriptions_SubscriptionsPatchResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '401':
          description: Unauthorized. The API key or OAuth access token is missing, invalid, or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type__Error'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                subscriptions:
                  type: array
                  items:
                    $ref: '#/components/schemas/type_bulkSubscriptionUpdates_SubscriptionsPatchRequestSubscriptionsItem'
                  description: An array of objects representing the subscriptions to be updated (max 1000).
  /publications/{publicationId}/subscriptions:
    put:
      operationId: put-status
      summary: 'Update subscriptions'' status OAuth Scope: subscriptions:write'
      description: Bulk update subscriptions' status.
      tags:
      - Bulk Subscription Updates
      parameters:
      - name: publicationId
        in: path
        description: The prefixed ID of the publication object
        required: true
        schema:
          $ref: '#/components/schemas/type_ids_PublicationId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                subscription_ids:
                  type: array
                  items:
                    type: string
                  description: An array of subscription IDs to be updated
                new_status:
                  type: string
                  description: The new status to set for the subscriptions
              required:
              - subscription_ids
              - new_status
    patch:
      operationId: patch-status
      summary: 'Update subscriptions'' status OAuth Scope: subscriptions:write'
      description: Bulk update subscriptions' status.
      tags:
      - Bulk Subscription Updates
      parameters:
      - name: publicationId
        in: path
        description: The prefixed ID of the publication object
        required: true
        schema:
          $ref: '#/components/schemas/type_ids_PublicationId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                subscription_ids:
                  type: array
                  items:
                    type: string
                  description: An array of subscription IDs to be updated
                new_status:
                  type: string
                  description: The new status to set for the subscriptions
              required:
              - subscription_ids
              - new_status
components:
  schemas:
    type_bulkSubscriptionUpdates_SubscriptionsPatchRequestSubscriptionsItemTier:
      type: string
      enum:
      - free
      - premium
      description: The Tier of the Subscription (not required)
      title: SubscriptionsPatchRequestSubscriptionsItemTier
    type_ids_PublicationId:
      type: string
      description: The prefixed ID of the publication.
      title: PublicationId
    type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesListResponseDataItemType:
      type: string
      enum:
      - status
      - bulk
      description: The type of update (status or bulk)
      title: BulkSubscriptionUpdatesListResponseDataItemType
    type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesListResponseDataItem:
      type: object
      properties:
        id:
          type: string
          description: The ID of the update object
        type:
          $ref: '#/components/schemas/type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesListResponseDataItemType'
          description: The type of update (status or bulk)
        params:
          type: string
          description: The parameters passed in for the update
        status:
          $ref: '#/components/schemas/type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesListResponseDataItemStatus'
          description: The status of the update
        publication_id:
          $ref: '#/components/schemas/type_ids_PublicationId'
          description: The publication ID associated with this update
        failure_reason:
          type: string
          description: If the job as a whole fails, this will detail the errors encountered
        completed:
          type: integer
          description: The timestamp of the job's completion
        created:
          type: integer
          description: The timestamp of the job's creation
        updated:
          type: integer
          description: The timestamp of the job's update
        error_log:
          type: array
          items:
            type: string
          description: An array of errors encountered for individual updates within the job
      title: BulkSubscriptionUpdatesListResponseDataItem
    type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesGetResponseData:
      type: object
      properties:
        id:
          type: string
          description: The ID of the update object
        type:
          $ref: '#/components/schemas/type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesGetResponseDataType'
          description: The type of update (status or bulk)
        params:
          type: string
          description: The parameters passed in for the update
        status:
          $ref: '#/components/schemas/type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesGetResponseDataStatus'
          description: The status of the update
        publication_id:
          $ref: '#/components/schemas/type_ids_PublicationId'
          description: The publication ID associated with this update
        failure_reason:
          type: string
          description: If the job as a whole fails, this will detail the errors encountered
        completed:
          type: integer
          description: The timestamp of the job's completion
        created:
          type: integer
          description: The timestamp of the job's creation
        updated:
          type: integer
          description: The timestamp of the job's update
        error_log:
          type: array
          items:
            type: string
          description: An array of errors encountered for individual updates within the job
      title: BulkSubscriptionUpdatesGetResponseData
    type_ids_SubscriptionId:
      type: string
      description: The prefixed ID of the subscription.
      title: SubscriptionId
    type_subscriptions_SubscriptionsPatchResponseData:
      type: object
      properties:
        subscription_update_id:
          type: string
          description: The ID of the Subscription Update object responsible for handling the update job
      title: SubscriptionsPatchResponseData
    type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesGetResponseDataStatus:
      type: string
      enum:
      - pending
      - processing
      - complete
      - failed
      description: The status of the update
      title: BulkSubscriptionUpdatesGetResponseDataStatus
    type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesGetResponseDataType:
      type: string
      enum:
      - bulk
      - status
      description: The type of update (status or bulk)
      title: BulkSubscriptionUpdatesGetResponseDataType
    type_bulkSubscriptionUpdates_SubscriptionsPatchRequestSubscriptionsItem:
      type: object
      properties:
        subscription_id:
          $ref: '#/components/schemas/type_ids_SubscriptionId'
        tier:
          $ref: '#/components/schemas/type_bulkSubscriptionUpdates_SubscriptionsPatchRequestSubscriptionsItemTier'
          description: The Tier of the Subscription (not required)
        stripe_customer_id:
          $ref: '#/components/schemas/type_ids_OptionalStripeCustomerId'
          description: The Stripe Customer ID of the subscription (not required)
        unsubscribe:
          type: boolean
          description: A boolean value specifying whether to unsubscribe this subscription from the publication (not required)
        custom_fields:
          type: array
          items:
            $ref: '#/components/schemas/type_bulkSubscriptionUpdates_SubscriptionsPatchRequestSubscriptionsItemCustomFieldsItem'
          description: An array of custom field objects to update
        complimentary_gift_id:
          $ref: '#/components/schemas/type_ids_ComplimentaryAccessId'
          description: The prefixed ID of a complimentary access object to apply to this subscription. The complimentary access must belong to the same publication.
      required:
      - subscription_id
      title: SubscriptionsPatchRequestSubscriptionsItem
    type_ids_OptionalStripeCustomerId:
      type: string
      description: The prefixed ID of the Stripe customer.
      title: OptionalStripeCustomerId
    type__Error:
      type: object
      properties:
        status:
          type: integer
        statusText:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/type__ErrorDetail'
      required:
      - status
      - statusText
      - errors
      description: The top level error response.
      title: Error
    type_bulkSubscriptionUpdates_SubscriptionsPatchRequestSubscriptionsItemCustomFieldsItem:
      type: object
      properties:
        name:
          type: string
          description: The display value of the custom field
        value:
          $ref: '#/components/schemas/type__CustomFieldDataType'
          description: The value of the custom field
        delete:
          type: boolean
          description: A boolean value to specify whether to delete this custom field entry from the subscription
      title: SubscriptionsPatchRequestSubscriptionsItemCustomFieldsItem
    type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesListResponseDataItem'
          description: An array of Subscription Update objects
      title: BulkSubscriptionUpdatesListResponse
    type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesGetResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesGetResponseData'
      title: BulkSubscriptionUpdatesGetResponse
    type_ids_ComplimentaryAccessId:
      type: string
      description: The prefixed ID of the complimentary access object.
      title: ComplimentaryAccessId
    type_bulkSubscriptionUpdates_BulkSubscriptionUpdatesListResponseDataItemStatus:
      type: string
      enum:
      - pending
      - processing
      - complete
      - failed
      description: The status of the update
      title: BulkSubscriptionUpdatesListResponseDataItemStatus
    type__ErrorDetail:
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      title: ErrorDetail
    type__CustomFieldDataType:
      oneOf:
      - type: string
      - type: number
        format: double
      - type: boolean
      - type: array
        items:
          type: string
      title: CustomFieldDataType
    type_subscriptions_SubscriptionsPatchResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_subscriptions_SubscriptionsPatchResponseData'
      required:
      - data
      title: SubscriptionsPatchResponse
  securitySchemes:
    BearerAuthScheme:
      type: http
      scheme: bearer

beehiiv Bulk Subscription Updates API

Operations 6

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification