beehiiv · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Newsletter List Subscriptions API

6 actions 6 updates phrasing extends openapi/beehiiv-newsletter-list-subscriptions-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for beehiiv's API. It is a proposal applied on top of the contract, not a document beehiiv publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions'].get

$.paths['/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions'].post

$.paths['/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/{newsletterListSubscriptionId}'].get

$.paths['/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/{newsletterListSubscriptionId}'].patch

$.paths['/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/by_subscription_id/{subscriptionId}'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reference Newsletter List Subscriptions API
  version: 1.0.0
extends: openapi/beehiiv-newsletter-list-subscriptions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscribers on a newsletter list
      effect: read
      questions:
      - Who is subscribed to a particular newsletter list?
      - Can I page through a list's members newest first?
      instructions:
      - text: List subscriptions on newsletter list {list} in publication {publication}.
        slots:
          list: path.newsletterListId
          publication: path.publicationId
      - text: Show members of newsletter list {list} sorted {direction}.
        slots:
          list: path.newsletterListId
          direction: query.direction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an existing subscriber to a newsletter list
      effect: write
      questions:
      - How do I put a current subscriber onto one of my newsletter lists?
      - Can I add someone to a list by email instead of subscription ID?
      instructions:
      - text: Add {email} to newsletter list {list} on publication {publication}.
        slots:
          email: requestBody.email
          list: path.newsletterListId
          publication: path.publicationId
      - text: Enroll subscription {subscription} in newsletter list {list}.
        slots:
          subscription: requestBody.subscription_id
          list: path.newsletterListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/{newsletterListSubscriptionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one newsletter list membership
      effect: read
      questions:
      - What are the details of a single list membership record?
      - Can I look up one newsletter list subscription by its own ID?
      instructions:
      - text: Get newsletter list subscription {membership} on list {list} in {publication}.
        slots:
          membership: path.newsletterListSubscriptionId
          list: path.newsletterListId
          publication: path.publicationId
      - text: Show list membership record {membership} on newsletter list {list}.
        slots:
          membership: path.newsletterListSubscriptionId
          list: path.newsletterListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/{newsletterListSubscriptionId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe a list membership by its ID
      effect: write
      questions:
      - How do I remove someone from a newsletter list using the list subscription ID?
      - Can I unsubscribe a list membership without touching their main subscription?
      instructions:
      - text: Unsubscribe list membership {membership} from newsletter list {list} on {publication}.
        slots:
          membership: path.newsletterListSubscriptionId
          list: path.newsletterListId
          publication: path.publicationId
      - text: Take list subscription {membership} off newsletter list {list}.
        slots:
          membership: path.newsletterListSubscriptionId
          list: path.newsletterListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/newsletter_lists/{newsletterListId}/subscriptions/by_subscription_id/{subscriptionId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe from a list by subscription ID
      effect: write
      questions:
      - What if I only have the subscriber's subscription ID and want them off a newsletter list?
      - Can I unsubscribe someone from a list without knowing the list membership ID?
      instructions:
      - text: Remove subscription {subscription} from newsletter list {list} on publication {publication}.
        slots:
          subscription: path.subscriptionId
          list: path.newsletterListId
          publication: path.publicationId
      - text: Unsubscribe subscriber {subscription} from list {list} without the membership ID.
        slots:
          subscription: path.subscriptionId
          list: path.newsletterListId
      method: generated
      generated: '2026-09-26'