GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 Suppressions API

6 actions 6 updates phrasing extends openapi/getresponse-suppressions-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 6

$.info
$.paths['/suppressions/{suppressionId}'].get
$.paths['/suppressions/{suppressionId}'].post
$.paths['/suppressions/{suppressionId}'].delete
$.paths['/suppressions'].get
$.paths['/suppressions'].post

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 Suppressions API
  version: 1.0.0
extends: openapi/getresponse-suppressions-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: 5
- target: $.paths['/suppressions/{suppressionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a suppression list
      effect: read
      questions:
      - Which masks are in one of my suppression lists?
      - Can I view a suppression list by its ID?
      instructions:
      - text: Show suppression list {suppressionId}.
        slots:
          suppressionId: path.suppressionId
      - text: Get the masks in suppression list {suppressionId}.
        slots:
          suppressionId: path.suppressionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/suppressions/{suppressionId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a suppression list
      effect: write
      questions:
      - Can I rename a suppression list or change its masks?
      - Is it possible to add more addresses to an existing suppression list?
      instructions:
      - text: Set the masks of suppression list {suppressionId} to {masks}.
        slots:
          suppressionId: path.suppressionId
          masks: requestBody.masks
      - text: Rename suppression list {suppressionId} to {name}.
        slots:
          suppressionId: path.suppressionId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/suppressions/{suppressionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a suppression list
      effect: destructive
      questions:
      - How do I remove a suppression list I don't need?
      - Can a suppression list be permanently deleted?
      instructions:
      - text: Delete suppression list {suppressionId}.
        slots:
          suppressionId: path.suppressionId
      - text: Permanently remove suppression list {suppressionId}.
        slots:
          suppressionId: path.suppressionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/suppressions'].get
  update:
    x-apievangelist-phrasing:
      intent: List suppression lists
      effect: read
      questions:
      - Which suppression lists have I created?
      - Can I find suppression lists by name or creation date?
      instructions:
      - text: List all my suppression lists.
      - text: Find suppression lists named {name}.
        slots:
          name: query.query[name]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/suppressions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a suppression list
      effect: write
      questions:
      - How do I make a list of addresses to exclude from sends?
      - Can I create a suppression list with email and domain masks?
      instructions:
      - text: Create a suppression list named {name} with masks {masks}.
        slots:
          name: requestBody.name
          masks: requestBody.masks
      - text: Make a new exclusion list called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'