GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 From Fields API

6 actions 6 updates phrasing extends openapi/getresponse-from-fields-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['/from-fields/{fromFieldId}'].get
$.paths['/from-fields/{fromFieldId}'].delete
$.paths['/from-fields/{fromFieldId}/default'].post
$.paths['/from-fields'].get
$.paths['/from-fields'].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 From Fields API
  version: 1.0.0
extends: openapi/getresponse-from-fields-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['/from-fields/{fromFieldId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sender (From) address
      effect: read
      questions:
      - What name and email does one of my From addresses use?
      - Can I check a specific sender address by its ID?
      instructions:
      - text: Show From address {fromFieldId}.
        slots:
          fromFieldId: path.fromFieldId
      - text: Get the sender name and email of From address {fromFieldId}.
        slots:
          fromFieldId: path.fromFieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/from-fields/{fromFieldId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sender (From) address
      effect: destructive
      questions:
      - Can I remove a sender address and swap in another one where it was used?
      - What happens to messages using a From address I delete?
      instructions:
      - text: Delete From address {fromFieldId}.
        slots:
          fromFieldId: path.fromFieldId
      - text: Delete From address {fromFieldId} and replace it with {fromFieldIdToReplaceWith}.
        slots:
          fromFieldId: path.fromFieldId
          fromFieldIdToReplaceWith: query.fromFieldIdToReplaceWith
      method: generated
      generated: '2026-09-26'
- target: $.paths['/from-fields/{fromFieldId}/default'].post
  update:
    x-apievangelist-phrasing:
      intent: Make a sender address the default
      effect: write
      questions:
      - How do I change which From address is used by default?
      - Can I set a different sender as my account default?
      instructions:
      - text: Make From address {fromFieldId} my default sender.
        slots:
          fromFieldId: path.fromFieldId
      - text: Set {fromFieldId} as the account's default From address.
        slots:
          fromFieldId: path.fromFieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/from-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List sender (From) addresses
      effect: read
      questions:
      - Which sender addresses are set up on my account?
      - Can I list only active or default From addresses?
      instructions:
      - text: List all my From addresses.
      - text: Find the From address with email {email}.
        slots:
          email: query.query[email]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/from-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a sender (From) address
      effect: write
      questions:
      - How do I add a new sender email address?
      - What name and email are needed to create a From address?
      instructions:
      - text: Add From address {email} with display name {name}.
        slots:
          email: requestBody.email
          name: requestBody.name
      - text: Create a new sender address {email} named {name}.
        slots:
          email: requestBody.email
          name: requestBody.name
      method: generated
      generated: '2026-09-26'