API Evangelist conversational phrasing for Partner Service Prospects API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Partner Service Prospects API
  version: 1.0.0
extends: openapi/explorium-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: 9
- target: $.paths['/v1/prospects/match'].post
  update:
    x-apievangelist-phrasing:
      intent: Match people to prospect IDs
      effect: read
      questions:
      - How do I turn names, emails or LinkedIn URLs into prospect IDs?
      - Does prospect matching keep my input order?
      instructions:
      - text: 'Match these people to prospect IDs: {prospects_to_match}.'
        slots:
          prospects_to_match: requestBody.prospects_to_match
      - text: Find the prospect ID for each person in {prospects_to_match}.
        slots:
          prospects_to_match: requestBody.prospects_to_match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/prospects'].post
  update:
    x-apievangelist-phrasing:
      intent: Search prospects by role, seniority and company
      effect: read
      questions:
      - Can I find people by job title, seniority and the company they work for?
      - Which contacts match my buyer persona, page by page?
      - Can I exclude prospects I already have from a people search?
      instructions:
      - text: Find prospects matching {filters}.
        slots:
          filters: requestBody.filters
      - text: Search people with {filters}, {page_size} per page.
        slots:
          filters: requestBody.filters
          page_size: requestBody.page_size
      - text: Get the next page of prospect results with cursor {next_cursor}.
        slots:
          next_cursor: requestBody.next_cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/prospects/stats'].post
  update:
    x-apievangelist-phrasing:
      intent: Count prospects matching filters
      effect: read
      questions:
      - How many people match my persona filters before I export them?
      - Can I get stats on the size of a prospect segment?
      instructions:
      - text: Count prospects matching {filters}.
        slots:
          filters: requestBody.filters
      - text: Get prospect stats for the segment {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/prospects/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch events for prospects
      effect: read
      questions:
      - What job changes or other events happened for these people recently?
      - Can I pull prospect events within a time window?
      instructions:
      - text: Fetch {event_types} events for prospects {prospect_ids}.
        slots:
          event_types: requestBody.event_types
          prospect_ids: requestBody.prospect_ids
      - text: Get events for people {prospect_ids} since {timestamp_from}.
        slots:
          prospect_ids: requestBody.prospect_ids
          timestamp_from: requestBody.timestamp_from
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/prospects/autocomplete'].get
  update:
    x-apievangelist-phrasing:
      intent: Autocomplete prospect filter values
      effect: read
      questions:
      - What values can I use for a people search field like job title?
      - Can I get type-ahead suggestions for a prospect filter?
      instructions:
      - text: Suggest values for prospect field {field} starting with {query}.
        slots:
          field: query.field
          query: query.query
      - text: Autocomplete people field {field} semantically for {query}.
        slots:
          field: query.field
          query: query.query
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/prospects/events/enrollments'].get
  update:
    x-apievangelist-phrasing:
      intent: List my prospect event enrollments
      effect: read
      questions:
      - Which people am I currently monitoring for events?
      - Can I see all my prospect event subscriptions?
      instructions:
      - text: List my prospect event enrollments.
      - text: Show which prospects I'm enrolled to get events for.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/prospects/events/enrollments'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll prospects for event monitoring
      effect: write
      questions:
      - How do I start tracking a set of people for job changes and other events?
      - Can I subscribe to chosen event types for specific prospects?
      instructions:
      - text: Enroll prospects {prospect_ids} for {event_types} events under key {enrollment_key}.
        slots:
          prospect_ids: requestBody.prospect_ids
          event_types: requestBody.event_types
          enrollment_key: requestBody.enrollment_key
      - text: Start monitoring people {prospect_ids} for {event_types} with enrollment key {enrollment_key}.
        slots:
          prospect_ids: requestBody.prospect_ids
          event_types: requestBody.event_types
          enrollment_key: requestBody.enrollment_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/prospects/events/enrollments'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a prospect event enrollment
      effect: destructive
      questions:
      - How do I stop tracking people for events?
      - Can I delete a prospect enrollment I don't need anymore?
      instructions:
      - text: Delete prospect enrollment {enrollment_id}.
        slots:
          enrollment_id: requestBody.enrollment_id
      - text: Stop prospect event monitoring for enrollment {enrollment_id}.
        slots:
          enrollment_id: requestBody.enrollment_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/prospects/events/enrollments'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a prospect event enrollment
      effect: write
      questions:
      - Can I change which people or event types an existing prospect enrollment covers?
      - What do I send to edit a people-monitoring enrollment?
      instructions:
      - text: Update prospect enrollment {enrollment_id} to cover {prospect_ids} for {event_types} with key {enrollment_key}.
        slots:
          enrollment_id: requestBody.enrollment_id
          prospect_ids: requestBody.prospect_ids
          event_types: requestBody.event_types
          enrollment_key: requestBody.enrollment_key
      - text: Change the tracked people on enrollment {enrollment_id} to {prospect_ids}.
        slots:
          enrollment_id: requestBody.enrollment_id
          prospect_ids: requestBody.prospect_ids
      method: generated
      generated: '2026-10-01'