# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snov.io Prospects API
  version: 1.0.0
extends: openapi/snov-io-prospects-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/v1/add-prospect'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a prospect to a list
      effect: write
      questions:
      - How do I add a new contact to one of my prospect lists?
      - Can I include custom fields when adding a prospect?
      instructions:
      - text: Add {email} to prospect list {list_id}.
        slots:
          email: requestBody.email
          list_id: requestBody.list_id
      - text: Add {first_name} {last_name} ({email}) at {company} to list {list_id}.
        slots:
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          email: requestBody.email
          company: requestBody.company
          list_id: requestBody.list_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/find-prospect-by-id'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up a prospect by ID
      effect: read
      questions:
      - Can I fetch a prospect record if I have its ID?
      - What details are stored for a prospect ID?
      instructions:
      - text: Find prospect with ID {id}.
        slots:
          id: requestBody.id
      - text: Look up prospect record {id}.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/find-prospect-by-email'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up a saved prospect by email
      effect: read
      questions:
      - Is this email address already saved as a prospect in my lists?
      - Can I find a saved prospect using only their email?
      instructions:
      - text: Find the saved prospect with email {email}.
        slots:
          email: requestBody.email
      - text: Check my prospects for {email}.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/prospect-custom-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List prospect custom fields
      effect: read
      questions:
      - What custom fields are defined for my prospects?
      - Which extra prospect fields can I fill in?
      instructions:
      - text: List my prospect custom fields.
      - text: Show all custom fields defined on prospects.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/user-lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List prospect lists
      effect: read
      questions:
      - Which prospect lists do I have?
      - Can I get the IDs of all my prospect lists?
      instructions:
      - text: List my prospect lists.
      - text: Show every prospect list on my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/view-prospects-in-list'].post
  update:
    x-apievangelist-phrasing:
      intent: View the prospects in a list
      effect: read
      questions:
      - Who is in a specific prospect list?
      - Can I page through the contacts in a large prospect list?
      instructions:
      - text: Show the prospects in list {list_id}.
        slots:
          list_id: requestBody.list_id
      - text: Get page {page} of list {list_id}, {per_page} prospects per page.
        slots:
          page: requestBody.page
          list_id: requestBody.list_id
          per_page: requestBody.per_page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/create-prospect-list'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a prospect list
      effect: write
      questions:
      - How do I create a new list to organize prospects?
      - Can I make a prospect list just by giving it a name?
      instructions:
      - text: Create a prospect list called {name}.
        slots:
          name: requestBody.name
      - text: Make a new list named {name} for my prospects.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'