GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 RSS Newsletters API

8 actions 8 updates phrasing extends openapi/getresponse-rss-newsletters-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for GetResponse's API. It is a proposal applied on top of the contract, not a document GetResponse publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/rss-newsletters/{rssNewsletterId}'].get
$.paths['/rss-newsletters/{rssNewsletterId}'].post
$.paths['/rss-newsletters/{rssNewsletterId}'].delete
$.paths['/rss-newsletters/{rssNewsletterId}/statistics'].get
$.paths['/rss-newsletters'].get
$.paths['/rss-newsletters'].post
$.paths['/rss-newsletters/statistics'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for GetResponse APIv3 RSS Newsletters API
  version: 1.0.0
extends: openapi/getresponse-rss-newsletters-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: 7
- target: $.paths['/rss-newsletters/{rssNewsletterId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an RSS newsletter's settings
      effect: read
      questions:
      - What feed URL and send settings does one RSS newsletter use?
      - Can I look up a single RSS-to-email newsletter by ID?
      instructions:
      - text: Get RSS newsletter {rss}.
        slots:
          rss: path.rssNewsletterId
      - text: Show the {fields} of RSS newsletter {rss}.
        slots:
          fields: query.fields
          rss: path.rssNewsletterId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rss-newsletters/{rssNewsletterId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an RSS newsletter
      effect: write
      questions:
      - Can I change the feed URL or subject of an existing RSS newsletter?
      - Is it possible to pause an RSS newsletter by changing its status?
      instructions:
      - text: Change the feed of RSS newsletter {rss} to {feed}.
        slots:
          rss: path.rssNewsletterId
          feed: requestBody.rssFeedUrl
      - text: Set the subject of RSS newsletter {rss} to {subject}.
        slots:
          rss: path.rssNewsletterId
          subject: requestBody.subject
      - text: Set RSS newsletter {rss} status to {status}.
        slots:
          rss: path.rssNewsletterId
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rss-newsletters/{rssNewsletterId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an RSS newsletter
      effect: destructive
      questions:
      - How do I stop and remove an RSS-driven newsletter for good?
      - Is deleting an RSS newsletter irreversible?
      instructions:
      - text: Delete RSS newsletter {rss}.
        slots:
          rss: path.rssNewsletterId
      - text: Remove RSS newsletter {rss} permanently.
        slots:
          rss: path.rssNewsletterId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rss-newsletters/{rssNewsletterId}/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get stats for one RSS newsletter
      effect: read
      questions:
      - How is one particular RSS newsletter performing?
      - Can I see a single RSS newsletter's stats grouped by day?
      instructions:
      - text: Show statistics for RSS newsletter {rss}.
        slots:
          rss: path.rssNewsletterId
      - text: Report stats for RSS newsletter {rss} from {from} to {to}.
        slots:
          rss: path.rssNewsletterId
          from: query.query[createdOn][from]
          to: query.query[createdOn][to]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rss-newsletters'].get
  update:
    x-apievangelist-phrasing:
      intent: List my RSS newsletters
      effect: read
      questions:
      - What RSS newsletters have I set up?
      - Can I find RSS newsletters that are currently active on a given list?
      instructions:
      - text: List my RSS newsletters.
      - text: Find RSS newsletters with status {status}.
        slots:
          status: query.query[status]
      - text: List RSS newsletters sending to list {campaign}.
        slots:
          campaign: query.query[campaignId]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rss-newsletters'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an RSS-to-email newsletter
      effect: write
      questions:
      - How do I turn a blog RSS feed into an automatic email newsletter?
      - Can I choose the from address and reply-to for an RSS newsletter?
      instructions:
      - text: Create an RSS newsletter from feed {feed} with subject {subject}.
        slots:
          feed: requestBody.rssFeedUrl
          subject: requestBody.subject
      - text: Set up RSS newsletter {name} using feed {feed}.
        slots:
          name: requestBody.name
          feed: requestBody.rssFeedUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rss-newsletters/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get stats across all RSS newsletters
      effect: read
      questions:
      - What are the combined statistics for all my RSS newsletters?
      - Can I compare RSS newsletter performance for one list over time?
      instructions:
      - text: Show statistics for all my RSS newsletters.
      - text: Report RSS newsletter stats for list {campaign} grouped by {groupBy}.
        slots:
          campaign: query.query[campaignId]
          groupBy: query.query[groupBy]
      method: generated
      generated: '2026-09-26'