ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ActiveCampaign SMS Broadcast Recipients API

3 actions 3 updates phrasing extends openapi/activecampaign-recipients-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for ActiveCampaign's API. It is a proposal applied on top of the contract, not a document ActiveCampaign publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/sms/broadcasts/{broadcastId}/recipients'].get

$.paths['/sms/broadcasts/{broadcastId}/recipients/export'].post

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 ActiveCampaign SMS Broadcast Recipients API
  version: 1.0.0
extends: openapi/activecampaign-recipients-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: 2
- target: $.paths['/sms/broadcasts/{broadcastId}/recipients'].get
  update:
    x-apievangelist-phrasing:
      intent: List recipients of an SMS broadcast
      effect: read
      questions:
      - Who received a specific SMS broadcast?
      - Can I filter broadcast recipients by delivery or engagement status?
      instructions:
      - text: List recipients of broadcast {broadcastId}.
        slots:
          broadcastId: path.broadcastId
      - text: Show recipients of broadcast {broadcastId} with deliverability {deliverability}.
        slots:
          broadcastId: path.broadcastId
          deliverability: query.filters[deliverability][]
      - text: List broadcast {broadcastId} recipients between {start_date} and {end_date}.
        slots:
          broadcastId: path.broadcastId
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms/broadcasts/{broadcastId}/recipients/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export SMS broadcast recipients to CSV
      effect: read
      questions:
      - How do I download a CSV of everyone who got a text broadcast?
      - Does the recipient export include full contact records?
      instructions:
      - text: Export recipients of broadcast {broadcastId} to CSV.
        slots:
          broadcastId: path.broadcastId
      - text: Export broadcast {broadcastId} recipients with engagement {engagement} as a CSV file.
        slots:
          broadcastId: path.broadcastId
          engagement: requestBody.engagement
      method: generated
      generated: '2026-09-26'