# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Settings Broadcast Messages API
  version: 1.0.0
extends: openapi/elation-health-broadcast-messages-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['/broadcast_messages/'].get
  update:
    x-apievangelist-phrasing:
      intent: List broadcast messages
      effect: read
      questions:
      - What broadcast messages have been sent to our practice's users?
      - Can I see all active announcements broadcast across the practice?
      instructions:
      - text: List all broadcast messages.
      - text: Show every practice-wide announcement currently broadcast.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/broadcast_messages/'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a broadcast message
      effect: write
      questions:
      - How do I broadcast an announcement to everyone in the practice?
      - Can an integration post a message that all practice users see?
      instructions:
      - text: Create a new broadcast message for the practice.
      - text: Broadcast an announcement to all practice users.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/broadcast_messages/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a broadcast message
      effect: destructive
      questions:
      - Can I take down a broadcast announcement after it's posted?
      - What's the way to remove an outdated broadcast message?
      instructions:
      - text: Delete broadcast message {id}.
        slots:
          id: path.id
      - text: Take down the outdated announcement {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'