beehiiv · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Referral Program API

2 actions 2 updates phrasing extends openapi/beehiiv-referral-program-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}/referral_program'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reference Referral Program API
  version: 1.0.0
extends: openapi/beehiiv-referral-program-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}/referral_program'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the referral program and its rewards
      effect: read
      questions:
      - What milestones and rewards are set up in my newsletter's referral program?
      - How many referrals does a reader need to earn each reward?
      instructions:
      - text: Show the referral program for publication {publication}.
        slots:
          publication: path.publicationId
      - text: List referral milestones and rewards on {publication}.
        slots:
          publication: path.publicationId
      method: generated
      generated: '2026-09-26'