GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 Autoresponders API

9 actions 9 updates phrasing extends openapi/getresponse-autoresponders-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 9

$.info
$.paths['/autoresponders/{autoresponderId}'].get
$.paths['/autoresponders/{autoresponderId}'].post
$.paths['/autoresponders/{autoresponderId}'].delete
$.paths['/autoresponders/{autoresponderId}/statistics'].get
$.paths['/autoresponders/{autoresponderId}/thumbnail'].get
$.paths['/autoresponders'].get
$.paths['/autoresponders'].post
$.paths['/autoresponders/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 Autoresponders API
  version: 1.0.0
extends: openapi/getresponse-autoresponders-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: 8
- target: $.paths['/autoresponders/{autoresponderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an autoresponder
      effect: read
      questions:
      - What subject and trigger settings does one of my autoresponders use?
      - Can I fetch a single autoresponder's details by ID?
      instructions:
      - text: Show autoresponder {autoresponderId}.
        slots:
          autoresponderId: path.autoresponderId
      - text: Get the subject and trigger settings of autoresponder {autoresponderId}.
        slots:
          autoresponderId: path.autoresponderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/autoresponders/{autoresponderId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an autoresponder
      effect: write
      questions:
      - Can I change the subject or content of an existing autoresponder?
      - Is it possible to pause an autoresponder by changing its status?
      instructions:
      - text: Change the subject of autoresponder {autoresponderId} to {subject}.
        slots:
          autoresponderId: path.autoresponderId
          subject: requestBody.subject
      - text: Set autoresponder {autoresponderId} status to {status}.
        slots:
          autoresponderId: path.autoresponderId
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/autoresponders/{autoresponderId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an autoresponder
      effect: destructive
      questions:
      - How can I remove an autoresponder I don't use anymore?
      - Can I permanently delete one autoresponder from a list?
      instructions:
      - text: Delete autoresponder {autoresponderId}.
        slots:
          autoresponderId: path.autoresponderId
      - text: Permanently remove autoresponder {autoresponderId}.
        slots:
          autoresponderId: path.autoresponderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/autoresponders/{autoresponderId}/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get statistics for one autoresponder
      effect: read
      questions:
      - How well is a particular autoresponder performing?
      - Can I see one autoresponder's results grouped by day or month?
      instructions:
      - text: Show statistics for autoresponder {autoresponderId}.
        slots:
          autoresponderId: path.autoresponderId
      - text: Get autoresponder {autoresponderId} stats grouped by {groupBy} from {from}.
        slots:
          autoresponderId: path.autoresponderId
          groupBy: query.query[groupBy]
          from: query.query[createdOn][from]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/autoresponders/{autoresponderId}/thumbnail'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an autoresponder thumbnail image
      effect: read
      questions:
      - Is there a preview image of an autoresponder message?
      - What size thumbnails are available for an autoresponder?
      instructions:
      - text: Get the thumbnail for autoresponder {autoresponderId}.
        slots:
          autoresponderId: path.autoresponderId
      - text: Fetch a {size} preview image of autoresponder {autoresponderId}.
        slots:
          size: query.size
          autoresponderId: path.autoresponderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/autoresponders'].get
  update:
    x-apievangelist-phrasing:
      intent: List autoresponders
      effect: read
      questions:
      - Which autoresponders do I have set up across my lists?
      - Can I sort my autoresponders by open rate or click rate?
      - How do I find autoresponders with a particular status?
      instructions:
      - text: List all my autoresponders.
      - text: Show autoresponders in list {campaignId} with status {status}.
        slots:
          campaignId: query.query[campaignId]
          status: query.query[status]
      - text: Find autoresponders named {name}.
        slots:
          name: query.query[name]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/autoresponders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an autoresponder
      effect: write
      questions:
      - Can I set up a new time-based autoresponder through the API?
      - Are action-based autoresponders still creatable, or did they move to automation?
      instructions:
      - text: Create an autoresponder named {name} with subject {subject} in list {campaignId}.
        slots:
          name: requestBody.name
          subject: requestBody.subject
          campaignId: requestBody.campaignId
      - text: Create an autoresponder with trigger settings {triggerSettings} and content {content}.
        slots:
          triggerSettings: requestBody.triggerSettings
          content: requestBody.content
      method: generated
      generated: '2026-09-26'
- target: $.paths['/autoresponders/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get combined autoresponder statistics
      effect: read
      questions:
      - What are the overall results across all autoresponders in a list?
      - Can I compare stats for several autoresponders at once?
      instructions:
      - text: Show combined statistics for all my autoresponders.
      - text: Get autoresponder stats for list {campaignId} grouped by {groupBy}.
        slots:
          campaignId: query.query[campaignId]
          groupBy: query.query[groupBy]
      method: generated
      generated: '2026-09-26'