# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hunter Campaigns API
  version: 1.0.0
extends: openapi/hunter-campaigns-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['/campaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: List my email campaigns
      effect: read
      questions:
      - How do I see all the email sequences in my Hunter account?
      - Can I list only the campaigns that have already been started?
      - Which of my campaigns are archived?
      instructions:
      - text: List my email campaigns.
      - text: Show my campaigns filtered by started = {started}.
        slots:
          started: query.started
      - text: List my archived campaigns, {limit} per page.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{id}/recipients'].get
  update:
    x-apievangelist-phrasing:
      intent: List the recipients of a campaign
      effect: read
      questions:
      - Who is enrolled as a recipient in a particular campaign?
      - Can I page through a campaign's recipient list?
      instructions:
      - text: Show the recipients of campaign {id}.
        slots:
          id: path.id
      - text: List {limit} recipients of campaign {id} starting at offset {offset}.
        slots:
          limit: query.limit
          id: path.id
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{id}/recipients'].post
  update:
    x-apievangelist-phrasing:
      intent: Add recipients to a campaign
      effect: write
      questions:
      - How do I enroll new people into an email sequence?
      - Can I add my saved leads to a campaign using their lead IDs?
      instructions:
      - text: Add {emails} as recipients to campaign {id}.
        slots:
          emails: requestBody.emails
          id: path.id
      - text: Enroll leads {lead_ids} in campaign {id}.
        slots:
          lead_ids: requestBody.lead_ids
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{id}/recipients'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel scheduled emails for campaign recipients
      effect: destructive
      questions:
      - How do I stop a campaign from sending any more emails to certain people?
      - Can I cancel the scheduled messages for a recipient without stopping the whole sequence?
      instructions:
      - text: Cancel all scheduled emails to {emails} in campaign {id}.
        slots:
          emails: requestBody.emails
          id: path.id
      - text: Pull {emails} out of campaign {id} so they get no further emails.
        slots:
          emails: requestBody.emails
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/campaigns/{id}/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an email campaign
      effect: write
      questions:
      - How do I kick off sending for an email sequence?
      - Can I launch a campaign through the API once its recipients are loaded?
      instructions:
      - text: Start campaign {id}.
        slots:
          id: path.id
      - text: Launch the email sequence for campaign {id} now.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'