# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twilio SendGrid Scheduled Sends API
  version: 1.0.0
extends: openapi/sendgrid-scheduled-sends-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v3/user/scheduled_sends'].get
  update:
    x-apievangelist-phrasing:
      intent: List cancelled or paused scheduled sends
      effect: read
      questions:
      - Which scheduled sends have I paused or cancelled?
      - Does this list include scheduled mail that has no batch ID?
      instructions:
      - text: List all cancelled and paused scheduled sends.
      - text: Show every scheduled send batch I've paused or cancelled.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/scheduled_sends'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel or pause a scheduled send
      effect: destructive
      questions:
      - Can I pause a scheduled email batch before it goes out?
      - How do I cancel mail scheduled under a batch ID?
      instructions:
      - text: Set scheduled batch {batch_id} to {status}.
        slots:
          batch_id: requestBody.batch_id
          status: requestBody.status
      - text: Cancel or pause the send for batch {batch_id} with status {status}.
        slots:
          batch_id: requestBody.batch_id
          status: requestBody.status
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/scheduled_sends/{batch_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the pause/cancel status of a batch
      effect: read
      questions:
      - Is a particular scheduled batch currently paused or cancelled?
      - What cancel or pause info exists for one batch ID?
      instructions:
      - text: Get the scheduled send status for batch {batch_id}.
        slots:
          batch_id: path.batch_id
      - text: Check whether batch {batch_id} is paused or cancelled.
        slots:
          batch_id: path.batch_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/scheduled_sends/{batch_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Lift a pause or cancellation on a batch
      effect: destructive
      questions:
      - Can I undo a pause on a scheduled batch so it sends again?
      - Are cancellations made less than 10 minutes before send time guaranteed?
      instructions:
      - text: Remove the pause or cancellation on batch {batch_id}.
        slots:
          batch_id: path.batch_id
      - text: Resume batch {batch_id} by deleting its cancel/pause.
        slots:
          batch_id: path.batch_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/scheduled_sends/{batch_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Switch a batch between pause and cancel
      effect: write
      questions:
      - Can I change a paused batch to cancelled instead?
      - Where do I update the status on a batch I already paused?
      instructions:
      - text: Change batch {batch_id}'s scheduled status to {status}.
        slots:
          batch_id: path.batch_id
          status: requestBody.status
      - text: Update the existing pause on batch {batch_id} to {status}.
        slots:
          batch_id: path.batch_id
          status: requestBody.status
      method: generated
      generated: '2026-09-24'