GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 Workflows API

4 actions 4 updates phrasing extends openapi/getresponse-workflows-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 4

$.info

$.paths['/workflow/{workflowId}'].get

$.paths['/workflow/{workflowId}'].post

$.paths['/workflow'].get

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 GetResponse APIv3 Workflows API
  version: 1.0.0
extends: openapi/getresponse-workflows-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: 3
- target: $.paths['/workflow/{workflowId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an automation workflow
      effect: read
      questions:
      - Can I see the details of one automation workflow?
      - Is a particular workflow currently active?
      instructions:
      - text: Get workflow {workflow}.
        slots:
          workflow: path.workflowId
      - text: Show the status of automation workflow {workflow}.
        slots:
          workflow: path.workflowId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflow/{workflowId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn an automation workflow on or off
      effect: write
      questions:
      - How do I pause or activate an automation workflow?
      - Can I change a workflow's status from the API?
      instructions:
      - text: Set workflow {workflow} status to {status}.
        slots:
          workflow: path.workflowId
          status: requestBody.status
      - text: Activate workflow {workflow} by setting status {status}.
        slots:
          workflow: path.workflowId
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workflow'].get
  update:
    x-apievangelist-phrasing:
      intent: List automation workflows
      effect: read
      questions:
      - Which automation workflows exist in my account?
      - What workflows are available to page through?
      instructions:
      - text: List all my automation workflows.
      - text: Show page {page} of my workflows.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'