beehiiv · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Automation Journeys API

4 actions 4 updates phrasing extends openapi/beehiiv-automation-journeys-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 4

$.info

$.paths['/publications/{publicationId}/automations/{automationId}/journeys'].get

$.paths['/publications/{publicationId}/automations/{automationId}/journeys'].post

$.paths['/publications/{publicationId}/automations/{automationId}/journeys/{automationJourneyId}'].get

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 Automation Journeys API
  version: 1.0.0
extends: openapi/beehiiv-automation-journeys-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: 3
- target: $.paths['/publications/{publicationId}/automations/{automationId}/journeys'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscriber journeys through an automation
      effect: read
      questions:
      - Which subscribers have gone through a particular automation?
      - Can I filter an automation's journeys by status, like only completed ones?
      instructions:
      - text: List the journeys for automation {automation} on publication {publication}.
        slots:
          automation: path.automationId
          publication: path.publicationId
      - text: Show {status} journeys in automation {automation}.
        slots:
          status: query.status
          automation: path.automationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/automations/{automationId}/journeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll an existing subscriber in an automation
      effect: write
      questions:
      - How do I add a current subscriber to an automation flow from my own app?
      - Can I bypass double opt-in when enrolling someone in an automation?
      - Does enrolling into an automation work for people who aren't subscribers yet?
      instructions:
      - text: Add {email} to automation {automation} on publication {publication}.
        slots:
          email: requestBody.email
          automation: path.automationId
          publication: path.publicationId
      - text: Enroll subscription {subscription} in automation {automation}.
        slots:
          subscription: requestBody.subscription_id
          automation: path.automationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/automations/{automationId}/journeys/{automationJourneyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one automation journey
      effect: read
      questions:
      - What happened in one specific subscriber's run through an automation?
      - Can I check the status of a single automation journey by its ID?
      instructions:
      - text: Get journey {journey} in automation {automation} for publication {publication}.
        slots:
          journey: path.automationJourneyId
          automation: path.automationId
          publication: path.publicationId
      - text: Check where journey {journey} stands in automation {automation}.
        slots:
          journey: path.automationJourneyId
          automation: path.automationId
      method: generated
      generated: '2026-09-26'