GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 Imports API

4 actions 4 updates phrasing extends openapi/getresponse-imports-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['/imports/{importId}'].get
$.paths['/imports'].get
$.paths['/imports'].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 Imports API
  version: 1.0.0
extends: openapi/getresponse-imports-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['/imports/{importId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contact import
      effect: read
      questions:
      - Has my contact import finished, and how many contacts were added?
      - Can I check the status of one import by ID?
      instructions:
      - text: Show import {importId}.
        slots:
          importId: path.importId
      - text: Check whether import {importId} has finished and how many contacts it added.
        slots:
          importId: path.importId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/imports'].get
  update:
    x-apievangelist-phrasing:
      intent: List contact imports
      effect: read
      questions:
      - Which contact imports have I run?
      - Can I sort imports by how many contacts were invalid?
      instructions:
      - text: List all my contact imports.
      - text: Show imports into list {campaignId}.
        slots:
          campaignId: query.query[campaignId]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/imports'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a contact import
      effect: write
      questions:
      - How do I add many contacts to a list in one call?
      - Since imports run asynchronously, how do I know when mine is done?
      instructions:
      - text: Import {contacts} into list {campaignId} using field mapping {fieldMapping}.
        slots:
          contacts: requestBody.contacts
          campaignId: requestBody.campaignId
          fieldMapping: requestBody.fieldMapping
      - text: Schedule a bulk upload of {contacts} to list {campaignId} mapped as {fieldMapping}.
        slots:
          contacts: requestBody.contacts
          campaignId: requestBody.campaignId
          fieldMapping: requestBody.fieldMapping
      method: generated
      generated: '2026-09-26'