# 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 Email Warm-up API
  version: 1.0.0
extends: openapi/snov-io-email-warm-up-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: 4
- target: $.paths['/v2/warm-up'].get
  update:
    x-apievangelist-phrasing:
      intent: List email warm-up campaigns
      effect: read
      questions:
      - Which mailboxes do I have warm-up running for?
      - Can I filter my warm-up campaigns by status?
      instructions:
      - text: List my warm-up campaigns.
      - text: Show warm-up campaigns with status {status}, page {page}, {per_page} per page.
        slots:
          status: query.status
          page: query.page
          per_page: query.per_page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/warm-up'].post
  update:
    x-apievangelist-phrasing:
      intent: Start warming up a sender mailbox
      effect: write
      questions:
      - How do I warm up a new mailbox to improve deliverability?
      - Can I ramp up warm-up volume gradually each day?
      - What percentage of warm-up emails can get replies?
      instructions:
      - text: Create a warm-up for email account {email_account_id} sending {per_day} emails a day.
        slots:
          email_account_id: requestBody.email_account_id
          per_day: requestBody.per_day
      - text: Warm up account {email_account_id} at {per_day} per day, starting at {from} and adding {increase} daily.
        slots:
          email_account_id: requestBody.email_account_id
          per_day: requestBody.per_day
          from: requestBody.from
          increase: requestBody.increase
      - text: Start warm-up on {email_account_id} at {per_day} a day with a {reply_rate}% reply rate.
        slots:
          email_account_id: requestBody.email_account_id
          per_day: requestBody.per_day
          reply_rate: requestBody.reply_rate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/warm-up/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a warm-up campaign's details
      effect: read
      questions:
      - What settings is a particular warm-up campaign using?
      - Can I see the full details of one warm-up by ID?
      instructions:
      - text: Show warm-up campaign {id}.
        slots:
          id: path.id
      - text: Get the full details of warm-up {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/warm-up/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a warm-up campaign's settings
      effect: write
      questions:
      - Can I pause a warm-up or make it run without an end date?
      - Is it possible to change daily volume on a warm-up that's already running?
      instructions:
      - text: Set the status of warm-up {id} to {status}.
        slots:
          id: path.id
          status: requestBody.status
      - text: Change existing warm-up {id} to send {per_day} emails a day.
        slots:
          id: path.id
          per_day: requestBody.per_day
      - text: 'Make warm-up {id} endless: {make_endless}.'
        slots:
          id: path.id
          make_endless: requestBody.make_endless
      method: generated
      generated: '2026-10-01'