GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 A/B tests - subject API

7 actions 7 updates phrasing extends openapi/getresponse-a-b-tests-subject-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 7

$.info
$.paths['/ab-tests/subject/{abTestId}/winner'].post
$.paths['/ab-tests/subject/{abTestId}'].get
$.paths['/ab-tests/{abTestId}/cancel'].post
$.paths['/ab-tests/{abTestId}'].delete
$.paths['/ab-tests/subject'].get
$.paths['/ab-tests/subject'].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 A/B tests - subject API
  version: 1.0.0
extends: openapi/getresponse-a-b-tests-subject-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: 6
- target: $.paths['/ab-tests/subject/{abTestId}/winner'].post
  update:
    x-apievangelist-phrasing:
      intent: Pick the winner of a subject A/B test
      effect: write
      questions:
      - Can I manually choose the winning subject line in an A/B test?
      - What do I pass to declare one variant the winner?
      instructions:
      - text: Declare variant {variantId} the winner of A/B test {abTestId}.
        slots:
          variantId: requestBody.variantId
          abTestId: path.abTestId
      - text: Pick variant {variantId} as the winning subject line for test {abTestId}.
        slots:
          variantId: requestBody.variantId
          abTestId: path.abTestId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ab-tests/subject/{abTestId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subject A/B test
      effect: read
      questions:
      - What variants and stage is a specific subject-line test in?
      - Can I look up one subject A/B test by its ID?
      instructions:
      - text: Show subject A/B test {abTestId}.
        slots:
          abTestId: path.abTestId
      - text: Get the variants and stage of subject test {abTestId}.
        slots:
          abTestId: path.abTestId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ab-tests/{abTestId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an A/B test
      effect: destructive
      questions:
      - Can I stop an A/B test that's in progress?
      - Is cancelling an A/B test immediate or does it happen asynchronously?
      instructions:
      - text: Cancel A/B test {abTestId}.
        slots:
          abTestId: path.abTestId
      - text: Stop the running A/B test {abTestId}.
        slots:
          abTestId: path.abTestId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ab-tests/{abTestId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an A/B test
      effect: destructive
      questions:
      - Which A/B test states allow deletion?
      - Can I permanently remove a finished or draft A/B test?
      instructions:
      - text: Delete A/B test {abTestId}.
        slots:
          abTestId: path.abTestId
      - text: Permanently remove the finished or draft A/B test {abTestId}.
        slots:
          abTestId: path.abTestId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ab-tests/subject'].get
  update:
    x-apievangelist-phrasing:
      intent: List subject A/B tests
      effect: read
      questions:
      - Which subject-line A/B tests have I run?
      - Can I filter my subject tests by stage or list?
      instructions:
      - text: List all my subject A/B tests.
      - text: Show subject A/B tests at stage {stage} in list {campaignId}.
        slots:
          stage: query.query[stage]
          campaignId: query.query[campaignId]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ab-tests/subject'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a subject A/B test
      effect: write
      questions:
      - How do I test two subject lines against each other?
      - What delivery settings are required to set up a subject-line test?
      instructions:
      - text: Create a subject A/B test named {name} for list {campaign} with variants {variants}.
        slots:
          name: requestBody.name
          campaign: requestBody.campaign
          variants: requestBody.variants
      - text: Set up a subject test from {fromField} with content {content}, delivery {deliverySettings} and send settings {sendSettings}.
        slots:
          fromField: requestBody.fromField
          content: requestBody.content
          deliverySettings: requestBody.deliverySettings
          sendSettings: requestBody.sendSettings
      method: generated
      generated: '2026-09-26'