beehiiv · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Subscription Tags API

2 actions 2 updates phrasing extends openapi/beehiiv-subscription-tags-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 2

$.info

$.paths['/publications/{publicationId}/subscriptions/{subscriptionId}/tags'].post

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 Subscription Tags API
  version: 1.0.0
extends: openapi/beehiiv-subscription-tags-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: 1
- target: $.paths['/publications/{publicationId}/subscriptions/{subscriptionId}/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Tag a subscriber
      effect: write
      questions:
      - How do I add tags to a subscriber?
      - What happens if I tag someone with a tag that doesn't exist yet?
      instructions:
      - text: Add tags {tags} to subscription {subscription} on publication {publication}.
        slots:
          tags: requestBody.tags
          subscription: path.subscriptionId
          publication: path.publicationId
      - text: Tag subscriber {subscription} with {tags}, creating any new tags.
        slots:
          subscription: path.subscriptionId
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'