# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reference Bulk Subscription Updates API
  version: 1.0.0
extends: openapi/beehiiv-bulk-subscription-updates-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: 6
- target: $.paths['/publications/{publicationId}/bulk_subscription_updates'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk subscription update jobs
      effect: read
      questions:
      - Where can I see the history of bulk subscriber updates I've run?
      - Which bulk subscription update jobs exist for my publication?
      instructions:
      - text: List bulk subscription update jobs for publication {publication}.
        slots:
          publication: path.publicationId
      - text: Show every bulk subscriber update I have run on {publication}.
        slots:
          publication: path.publicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/bulk_subscription_updates/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check one bulk subscription update job
      effect: read
      questions:
      - Did my bulk subscriber update finish successfully?
      - Can I check the progress of a single bulk update job?
      instructions:
      - text: Get bulk subscription update {update} for publication {publication}.
        slots:
          update: path.id
          publication: path.publicationId
      - text: Check whether bulk update job {update} has completed.
        slots:
          update: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/subscriptions/bulk_actions'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update subscription fields (PUT)
      effect: write
      questions:
      - How do I change custom fields and tiers for many subscribers at once using PUT?
      - Can I send a full PUT of bulk subscription changes including status and tiers?
      instructions:
      - text: 'Use the PUT bulk action to update these subscriptions on {publication}: {subscriptions}.'
        slots:
          publication: path.publicationId
          subscriptions: requestBody.subscriptions
      - text: Send a PUT bulk action changing status, custom fields and tiers for {subscriptions}.
        slots:
          subscriptions: requestBody.subscriptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/subscriptions/bulk_actions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Bulk update subscription fields (PATCH)
      effect: write
      questions:
      - Can I PATCH custom fields and tiers across a batch of subscribers?
      - What's the PATCH way to apply bulk subscriber field changes?
      instructions:
      - text: PATCH bulk subscriber field changes {subscriptions} on publication {publication}.
        slots:
          subscriptions: requestBody.subscriptions
          publication: path.publicationId
      - text: 'Apply these subscriber tier and custom field changes via PATCH: {subscriptions}.'
        slots:
          subscriptions: requestBody.subscriptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/subscriptions'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk set subscription status (PUT)
      effect: write
      questions:
      - How do I set the same status on a list of subscription IDs with a PUT request?
      - Can I mass-change subscribers to one status via PUT?
      instructions:
      - text: PUT status {new_status} on subscriptions {subscription_ids} in publication {publication}.
        slots:
          new_status: requestBody.new_status
          subscription_ids: requestBody.subscription_ids
          publication: path.publicationId
      - text: Mark subscriptions {subscription_ids} as {new_status} using the PUT status endpoint.
        slots:
          subscription_ids: requestBody.subscription_ids
          new_status: requestBody.new_status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/subscriptions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Bulk set subscription status (PATCH)
      effect: write
      questions:
      - Can I PATCH a batch of subscription IDs to a new status?
      - What's the PATCH endpoint for changing many subscribers' status at once?
      instructions:
      - text: PATCH subscriptions {subscription_ids} on {publication} to status {new_status}.
        slots:
          subscription_ids: requestBody.subscription_ids
          publication: path.publicationId
          new_status: requestBody.new_status
      - text: 'Switch these subscriptions to {new_status} with a PATCH: {subscription_ids}.'
        slots:
          new_status: requestBody.new_status
          subscription_ids: requestBody.subscription_ids
      method: generated
      generated: '2026-09-26'