GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 Tags API

6 actions 6 updates phrasing extends openapi/getresponse-tags-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['/tags/{tagId}'].get
$.paths['/tags/{tagId}'].post
$.paths['/tags/{tagId}'].delete
$.paths['/tags'].get
$.paths['/tags'].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 Tags API
  version: 1.0.0
extends: openapi/getresponse-tags-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['/tags/{tagId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tag
      effect: read
      questions:
      - Can I look up one tag by its ID?
      - What color and name does a specific tag have?
      instructions:
      - text: Get tag {tag}.
        slots:
          tag: path.tagId
      - text: Show the details of tag {tag}.
        slots:
          tag: path.tagId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags/{tagId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch a tag via the no-op update call
      effect: write
      questions:
      - Can I rename a tag or change its color after creating it?
      - What does the tag update call actually return, since edits are not allowed?
      instructions:
      - text: Send an update for tag {tag} with name {name}.
        slots:
          tag: path.tagId
          name: requestBody.name
      - text: Try setting the color of tag {tag} to {color}.
        slots:
          tag: path.tagId
          color: requestBody.color
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags/{tagId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag
      effect: destructive
      questions:
      - How do I delete a tag I don't use anymore?
      - Is removing a tag from my account permanent?
      instructions:
      - text: Delete tag {tag}.
        slots:
          tag: path.tagId
      - text: Remove tag {tag} from my account.
        slots:
          tag: path.tagId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List my tags
      effect: read
      questions:
      - Which tags exist in my account?
      - Can I find tags created within a certain date range?
      instructions:
      - text: List all my tags.
      - text: Find tags named {name}.
        slots:
          name: query.query[name]
      - text: List tags created between {from} and {to}.
        slots:
          from: query.query[createdAt][from]
          to: query.query[createdAt][to]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tag
      effect: write
      questions:
      - How do I create a new tag for segmenting contacts?
      - Can I pick a color when adding a tag?
      instructions:
      - text: Create a tag called {name}.
        slots:
          name: requestBody.name
      - text: Add a tag {name} with color {color}.
        slots:
          name: requestBody.name
          color: requestBody.color
      method: generated
      generated: '2026-09-26'