# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Optimizely Campaign REST Batch sending API
  version: 1.0.0
extends: openapi/optimizely-batch-sending-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['/{clientId}/sending/batches/{sendingBatchId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a sending batch
      effect: read
      questions:
      - What state is my campaign sending batch in, and which recipient list does it use?
      - Can I see which campaign a particular sending batch belongs to?
      instructions:
      - text: Get sending batch {sendingBatchId} for client {clientId}.
        slots:
          sendingBatchId: path.sendingBatchId
          clientId: path.clientId
      - text: Show the state and recipient list of batch {sendingBatchId} on client {clientId}.
        slots:
          sendingBatchId: path.sendingBatchId
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/sending/batches/{sendingBatchId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload a chunk of recipients to a batch
      effect: write
      questions:
      - How do I upload recipients to a sending batch in chunks before sending anything?
      - Can I stage recipients on a batch without starting the Optimizely campaign yet?
      instructions:
      - text: Add recipients {recipients} as chunk {chunk} to batch {sendingBatchId} for client {clientId}, without sending.
        slots:
          recipients: requestBody.recipients
          chunk: requestBody.chunk
          sendingBatchId: path.sendingBatchId
          clientId: path.clientId
      - text: Stage another recipient chunk on sending batch {sendingBatchId} of client {clientId}.
        slots:
          sendingBatchId: path.sendingBatchId
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/sending/batches/{sendingBatchId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Import recipients and send the batch campaign
      effect: destructive
      questions:
      - How do I finish a sending batch and actually start the campaign going out?
      - Can I include a final chunk of recipients in the same call that sends the batch?
      instructions:
      - text: Import the staged recipients and send batch {sendingBatchId} for client {clientId}.
        slots:
          sendingBatchId: path.sendingBatchId
          clientId: path.clientId
      - text: Send batch {sendingBatchId} on client {clientId}, including final recipients {recipients}, and mark it finished.
        slots:
          sendingBatchId: path.sendingBatchId
          clientId: path.clientId
          recipients: requestBody.recipients
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/sending/batches'].get
  update:
    x-apievangelist-phrasing:
      intent: List all sending batches
      effect: read
      questions:
      - Which sending batches exist for my client, and what state is each in?
      - Can I page through sending batches using an offset and limit?
      instructions:
      - text: List all sending batches for client {clientId}.
        slots:
          clientId: path.clientId
      - text: Show {limit} sending batches for client {clientId} starting at offset {offset}.
        slots:
          limit: query.limit
          clientId: path.clientId
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/sending/batches'].post
  update:
    x-apievangelist-phrasing:
      intent: Prepare a new campaign sending batch
      effect: write
      questions:
      - How do I set up a new sending batch from a campaign definition?
      - Does preparing a batch pick the next free recipient list from the pool automatically?
      instructions:
      - text: Prepare a new sending batch for client {clientId} with campaign {campaign} and action {campaignAction}.
        slots:
          clientId: path.clientId
          campaign: requestBody.campaign
          campaignAction: requestBody.campaignAction
      - text: Create a sending batch on client {clientId} tagged {tag} for campaign {campaign} using action {campaignAction}.
        slots:
          clientId: path.clientId
          tag: requestBody.tag
          campaign: requestBody.campaign
          campaignAction: requestBody.campaignAction
      method: generated
      generated: '2026-09-26'