# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lemlist Schedules API
  version: 1.0.0
extends: openapi/lemlist-schedules-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['/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List my sending schedules
      effect: read
      questions:
      - Which sending schedules exist in my lemlist team?
      - Can I sort my schedules by creation date, newest first?
      instructions:
      - text: List all my sending schedules.
      - text: Show page {page} of schedules, {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a sending schedule
      effect: write
      questions:
      - How do I set up a schedule so emails only go out on weekdays during business hours?
      - Can I control the delay between two sends in a schedule?
      instructions:
      - text: Create a schedule named {name} sending {weekdays} from {start} to {end} in {timezone}.
        slots:
          name: requestBody.name
          weekdays: requestBody.weekdays
          start: requestBody.start
          end: requestBody.end
          timezone: requestBody.timezone
      - text: Make a new schedule {name} waiting {secondsToWait} seconds between emails.
        slots:
          name: requestBody.name
          secondsToWait: requestBody.secondsToWait
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedules/{scheduleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one sending schedule
      effect: read
      questions:
      - What hours and days does a particular schedule send on?
      - Where can I see a single schedule's timezone?
      instructions:
      - text: Show schedule {scheduleId}.
        slots:
          scheduleId: path.scheduleId
      - text: Get the sending window of schedule {scheduleId}.
        slots:
          scheduleId: path.scheduleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedules/{scheduleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sending schedule
      effect: destructive
      questions:
      - Can I delete a schedule I no longer use?
      - How do I remove an old sending schedule?
      instructions:
      - text: Delete schedule {scheduleId}.
        slots:
          scheduleId: path.scheduleId
      - text: Remove the sending schedule {scheduleId}.
        slots:
          scheduleId: path.scheduleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedules/{scheduleId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a sending schedule
      effect: write
      questions:
      - How do I change the timezone of an existing schedule?
      - Can I adjust the sending hours on a schedule I already made?
      instructions:
      - text: Change schedule {scheduleId} to send from {start} to {end}.
        slots:
          scheduleId: path.scheduleId
          start: requestBody.start
          end: requestBody.end
      - text: Switch schedule {scheduleId} to timezone {timezone}.
        slots:
          scheduleId: path.scheduleId
          timezone: requestBody.timezone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaigns/{campaignId}/schedules/'].get
  update:
    x-apievangelist-phrasing:
      intent: List the schedules used by a campaign
      effect: read
      questions:
      - Which sending schedule is a campaign using?
      - When will a given campaign send its emails?
      instructions:
      - text: Show the schedules attached to campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      - text: Get campaign {campaignId}'s sending schedule.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaigns/{campaignId}/schedules/{scheduleId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a schedule to a campaign
      effect: write
      questions:
      - How do I apply an existing schedule to one of my campaigns?
      - Can I switch which schedule a campaign sends on?
      instructions:
      - text: Assign schedule {scheduleId} to campaign {campaignId}.
        slots:
          scheduleId: path.scheduleId
          campaignId: path.campaignId
      - text: Make campaign {campaignId} send on schedule {scheduleId}.
        slots:
          campaignId: path.campaignId
          scheduleId: path.scheduleId
      method: generated
      generated: '2026-10-01'