GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 Forms and Popups API

3 actions 3 updates phrasing extends openapi/getresponse-forms-and-popups-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 3

$.info
$.paths['/popups/{popupId}'].get
$.paths['/popups'].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 Forms and Popups API
  version: 1.0.0
extends: openapi/getresponse-forms-and-popups-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['/popups/{popupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a form or popup
      effect: read
      questions:
      - What are the settings of one of my signup forms or popups?
      - Can I look up a popup by its ID?
      instructions:
      - text: Show form or popup {popupId}.
        slots:
          popupId: path.popupId
      - text: Get the settings of signup popup {popupId}.
        slots:
          popupId: path.popupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/popups'].get
  update:
    x-apievangelist-phrasing:
      intent: List forms and popups
      effect: read
      questions:
      - Which of my forms and popups collect the most leads?
      - Can I filter popups by status and see their views?
      instructions:
      - text: List all my forms and popups.
      - text: Show forms and popups with status {status}, sorted by leads {leads}.
        slots:
          status: query.query[status]
          leads: query.sort[leads]
      method: generated
      generated: '2026-09-26'