# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ActiveCampaign SMS Broadcast Broadcasts API
  version: 1.0.0
extends: openapi/activecampaign-broadcasts-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['/sms/broadcasts'].get
  update:
    x-apievangelist-phrasing:
      intent: List SMS broadcast messages
      effect: read
      questions:
      - Which SMS broadcasts have I sent or scheduled?
      - Can I filter my text message broadcasts by status or name?
      - What SMS broadcasts went out between two dates?
      instructions:
      - text: List my SMS broadcasts with status {status}.
        slots:
          status: query.filters[status]
      - text: Show SMS broadcasts named {name}.
        slots:
          name: query.filters[name]
      - text: List SMS broadcasts from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms/broadcasts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an SMS broadcast
      effect: write
      questions:
      - How do I send a text message blast to a list in ActiveCampaign?
      - Can I schedule an SMS broadcast for later and target a segment?
      - Can an SMS broadcast include images through media URLs?
      instructions:
      - text: Create an SMS broadcast named {name} saying {body}.
        slots:
          name: requestBody.name
          body: requestBody.body
      - text: Create SMS broadcast {name} with text {body} to lists {list_ids}, scheduled for {scheduled_date}.
        slots:
          name: requestBody.name
          body: requestBody.body
          list_ids: requestBody.list_ids
          scheduled_date: requestBody.scheduled_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms/broadcasts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SMS broadcast
      effect: read
      questions:
      - What text, audience and schedule does a specific SMS broadcast have?
      - How many people was a particular SMS broadcast sent to?
      instructions:
      - text: Show SMS broadcast {id}.
        slots:
          id: path.id
      - text: Get the full details of text broadcast {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms/broadcasts/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an SMS broadcast
      effect: write
      questions:
      - Can I change the text of an SMS broadcast before it sends?
      - How do I reschedule an existing SMS broadcast?
      instructions:
      - text: Change the text of SMS broadcast {id} to {body}.
        slots:
          id: path.id
          body: requestBody.body
      - text: Reschedule SMS broadcast {id} for {scheduled_date}.
        slots:
          id: path.id
          scheduled_date: requestBody.scheduled_date
      - text: Retarget SMS broadcast {id} to segment {segment_id}.
        slots:
          id: path.id
          segment_id: requestBody.segment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms/broadcasts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SMS broadcast
      effect: destructive
      questions:
      - How do I remove an SMS broadcast I no longer need?
      - Is deleting a text broadcast a soft delete?
      instructions:
      - text: Delete SMS broadcast {id}.
        slots:
          id: path.id
      - text: Soft-delete text broadcast {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms/lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List SMS broadcast lists
      effect: read
      questions:
      - Which lists can I send SMS broadcasts to?
      - Can I search the SMS channel lists by name?
      instructions:
      - text: List all lists available for SMS broadcasts.
      - text: Find SMS lists named {name}.
        slots:
          name: query.filters[name]
      method: generated
      generated: '2026-09-26'