Hunter · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hunter Leads Lists API

6 actions 6 updates phrasing extends openapi/hunter-leads-lists-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Hunter's API. It is a proposal applied on top of the contract, not a document Hunter publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/leads_lists'].get
$.paths['/leads_lists'].post
$.paths['/leads_lists/{id}'].get
$.paths['/leads_lists/{id}'].put
$.paths['/leads_lists/{id}'].delete

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 Hunter Leads Lists API
  version: 1.0.0
extends: openapi/hunter-leads-lists-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['/leads_lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List my leads lists
      effect: read
      questions:
      - How do I see all the lead lists I've created in Hunter?
      - What's the maximum number of leads lists returned per page?
      instructions:
      - text: List all my leads lists.
      - text: Show {limit} of my leads lists, skipping the first {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads_lists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new leads list
      effect: write
      questions:
      - How do I make a new list to group my leads?
      - Can I create a named leads list through the API?
      instructions:
      - text: Create a leads list called {name}.
        slots:
          name: requestBody.name
      - text: Make a new list named {name} for organizing leads.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads_lists/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one leads list
      effect: read
      questions:
      - How can I look up the details of a single leads list by its ID?
      - What does one leads list record contain?
      instructions:
      - text: Show me leads list {id}.
        slots:
          id: path.id
      - text: Fetch the details of leads list {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads_lists/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a leads list
      effect: write
      questions:
      - How do I rename one of my existing leads lists?
      - Can I change the name of a list after I've created it?
      instructions:
      - text: Rename leads list {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the name of list {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads_lists/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a leads list
      effect: destructive
      questions:
      - How do I delete a leads list I no longer need?
      - Can I remove an entire leads list by its ID?
      instructions:
      - text: Delete leads list {id}.
        slots:
          id: path.id
      - text: Remove the list {id} from my account.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'