# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reference Data Deletion API
  version: 1.0.0
extends: openapi/beehiiv-data-deletion-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}/data_privacy/deletion_requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscriber data deletion requests
      effect: read
      questions:
      - Which GDPR-style data deletion requests have we filed?
      - Can I see every subscriber data deletion request for my organization?
      instructions:
      - text: List data deletion requests for publication {publication}.
        slots:
          publication: path.publicationId
      - text: Show all subscriber erasure requests filed for {publication}'s organization.
        slots:
          publication: path.publicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/data_privacy/deletion_requests'].post
  update:
    x-apievangelist-phrasing:
      intent: Request permanent deletion of a subscriber's data
      effect: destructive
      questions:
      - How do I erase a subscriber's personal data across all my publications?
      - Is there a waiting period before a data deletion request is processed?
      instructions:
      - text: File a data deletion request for {email} through publication {publication}.
        slots:
          email: requestBody.email
          publication: path.publicationId
      - text: Permanently redact all data for subscriber {email}.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/publications/{publicationId}/data_privacy/deletion_requests/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a data deletion request's status
      effect: read
      questions:
      - Has a specific subscriber data deletion request been completed yet?
      - What is the current status of one data deletion request?
      instructions:
      - text: Get data deletion request {request} on publication {publication}.
        slots:
          request: path.id
          publication: path.publicationId
      - text: Check whether data deletion request {request} has finished.
        slots:
          request: path.id
      method: generated
      generated: '2026-09-26'