beehiiv · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Newsletter Lists API

6 actions 6 updates phrasing extends openapi/beehiiv-newsletter-lists-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'].get

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

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

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

$.paths['/publications/{publicationId}/newsletter_lists/{newsletterListId}'].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 Lists API
  version: 1.0.0
extends: openapi/beehiiv-newsletter-lists-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List a publication's newsletter lists
      effect: read
      questions:
      - What newsletter lists does my publication have?
      - Can I sort my newsletter lists oldest first?
      instructions:
      - text: List the newsletter lists on publication {publication}.
        slots:
          publication: path.publicationId
      - text: Show the newsletter lists on {publication} sorted {direction}.
        slots:
          publication: path.publicationId
          direction: query.direction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/newsletter_lists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a newsletter list
      effect: write
      questions:
      - How do I start a new topic list that readers can subscribe to separately?
      - Can new subscribers be auto-subscribed to a list I create?
      instructions:
      - text: Create a newsletter list named {name} on publication {publication}.
        slots:
          name: requestBody.name
          publication: path.publicationId
      - text: Create newsletter list {name} with slug {slug} and description {description}.
        slots:
          name: requestBody.name
          slug: requestBody.slug
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/newsletter_lists/{newsletterListId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one newsletter list
      effect: read
      questions:
      - What are the settings of a specific newsletter list?
      - Can I retrieve a single newsletter list by its ID?
      instructions:
      - text: Get newsletter list {list} on publication {publication}.
        slots:
          list: path.newsletterListId
          publication: path.publicationId
      - text: Show the name, slug and settings of newsletter list {list}.
        slots:
          list: path.newsletterListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/newsletter_lists/{newsletterListId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a newsletter list
      effect: destructive
      questions:
      - How do I get rid of a newsletter list I no longer send?
      - Can I delete one of my topic lists entirely?
      instructions:
      - text: Delete newsletter list {list} from publication {publication}.
        slots:
          list: path.newsletterListId
          publication: path.publicationId
      - text: Remove the newsletter list {list} entirely.
        slots:
          list: path.newsletterListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/newsletter_lists/{newsletterListId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a newsletter list
      effect: write
      questions:
      - How do I rename a newsletter list or change its description?
      - Can I deactivate a newsletter list by changing its status?
      instructions:
      - text: Rename newsletter list {list} on {publication} to {name}.
        slots:
          list: path.newsletterListId
          publication: path.publicationId
          name: requestBody.name
      - text: Set the status of newsletter list {list} to {status}.
        slots:
          list: path.newsletterListId
          status: requestBody.status
      method: generated
      generated: '2026-09-26'