# 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 Confirmations API
  version: 1.0.0
extends: openapi/optimizely-confirmations-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: 21
- target: $.paths['/{clientId}/confirmations'].get
  update:
    x-apievangelist-phrasing:
      intent: List confirmation mailings
      effect: read
      questions:
      - Which confirmation mailings do I have set up and what status is each one in?
      - Can I filter my confirmation mailings to only SMS or only email ones?
      - How do I page through confirmation mailings stored in a specific folder?
      instructions:
      - text: List all confirmation mailings for client {clientId}.
        slots:
          clientId: path.clientId
      - text: List client {clientId}'s confirmation mailings with media type {mediaType} and status {status}.
        slots:
          clientId: path.clientId
          mediaType: query.mediaType
          status: query.status
      - text: Show the first {limit} confirmation mailings in folder {folderId} for client {clientId}.
        slots:
          limit: query.limit
          folderId: query.folderId
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a confirmation mailing
      effect: write
      questions:
      - How do I set up a new confirmation email that goes to a recipient list?
      - What do I need to supply when creating a confirmation mailing, like sender and subject?
      instructions:
      - text: Create a confirmation mailing for client {clientId} with subject {subject} sent from {senderAddress} to recipient lists {recipientListIds}.
        slots:
          clientId: path.clientId
          subject: requestBody.subject
          senderAddress: requestBody.senderAddress
          recipientListIds: requestBody.recipientListIds
      - text: Set up a new confirmation mailing named {name} for client {clientId} using content {content}.
        slots:
          name: requestBody.name
          clientId: path.clientId
          content: requestBody.content
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations/{confirmationMailId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a confirmation mailing
      effect: read
      questions:
      - What is the current status and type of one particular confirmation mailing?
      - When was a given confirmation mailing created?
      instructions:
      - text: Get confirmation mailing {confirmationMailId} for client {clientId}.
        slots:
          confirmationMailId: path.confirmationMailId
          clientId: path.clientId
      - text: Show the details of confirmation mailing {confirmationMailId}.
        slots:
          confirmationMailId: path.confirmationMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations/{confirmationMailId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a confirmation mailing
      effect: destructive
      questions:
      - How do I permanently remove a confirmation mailing I no longer use?
      - Can I delete a confirmation mailing by its ID?
      instructions:
      - text: Delete confirmation mailing {confirmationMailId} for client {clientId}.
        slots:
          confirmationMailId: path.confirmationMailId
          clientId: path.clientId
      - text: Remove confirmation mailing {confirmationMailId} entirely.
        slots:
          confirmationMailId: path.confirmationMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations/{confirmationMailId}/message'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a confirmation mailing's message
      effect: write
      questions:
      - How do I change the subject line or content of an existing confirmation mailing?
      - Can I change the reply-to address on a confirmation message after creating it?
      instructions:
      - text: Change the subject of confirmation mailing {confirmationMailId} to {subject}.
        slots:
          confirmationMailId: path.confirmationMailId
          subject: requestBody.subject
      - text: Update the message content of confirmation mailing {confirmationMailId} for client {clientId} to {content}.
        slots:
          confirmationMailId: path.confirmationMailId
          clientId: path.clientId
          content: requestBody.content
      - text: Set the reply-to address on confirmation mailing {confirmationMailId} to {replyToAddress}.
        slots:
          confirmationMailId: path.confirmationMailId
          replyToAddress: requestBody.replyToAddress
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations/{confirmationMailId}/message/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach files to a confirmation email
      effect: write
      questions:
      - How do I add a PDF or other attachment to a confirmation email?
      - Can I attach several files to a confirmation message in one request?
      instructions:
      - text: Add attachments {attachmentIds} to confirmation mailing {confirmationMailId}.
        slots:
          attachmentIds: requestBody.attachmentIds
          confirmationMailId: path.confirmationMailId
      - text: Attach files {attachmentIds} to the email message of confirmation mailing {confirmationMailId} for client {clientId}.
        slots:
          attachmentIds: requestBody.attachmentIds
          confirmationMailId: path.confirmationMailId
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations/{confirmationMailId}/message/attachments'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove attachments from a confirmation email
      effect: destructive
      questions:
      - How do I take an attachment off a confirmation email message?
      - Can I detach several files from a confirmation email at once?
      instructions:
      - text: Remove attachments {attachmentIds} from confirmation mailing {confirmationMailId}.
        slots:
          attachmentIds: query.attachmentIds
          confirmationMailId: path.confirmationMailId
      - text: Detach files {attachmentIds} from client {clientId}'s confirmation mailing {confirmationMailId}.
        slots:
          attachmentIds: query.attachmentIds
          clientId: path.clientId
          confirmationMailId: path.confirmationMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations/{confirmationMailId}/message/content'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a confirmation email's content
      effect: read
      questions:
      - What does the body of my confirmation email actually contain?
      - Can I get the confirmation email content as plain text instead of HTML?
      instructions:
      - text: Get the email content of client {clientId}'s confirmation mailing {confirmationMailId}.
        slots:
          clientId: path.clientId
          confirmationMailId: path.confirmationMailId
      - text: Fetch the content of confirmation mailing {confirmationMailId} as {Accept}.
        slots:
          confirmationMailId: path.confirmationMailId
          Accept: header.Accept
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations/{confirmationMailId}/message/test/{testMailingId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a test send report via the message path
      effect: read
      questions:
      - Did every recipient of my test send of the confirmation message actually receive it?
      - Which recipients of a confirmation message test are still enqueued or failed, per the message-level report?
      instructions:
      - text: Get the message-level test sending report {testMailingId} for confirmation mailing {confirmationMailId}.
        slots:
          testMailingId: path.testMailingId
          confirmationMailId: path.confirmationMailId
      - text: Show per-recipient status for message test {testMailingId} of confirmation mailing {confirmationMailId} under client {clientId}.
        slots:
          testMailingId: path.testMailingId
          confirmationMailId: path.confirmationMailId
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations/{confirmationMailId}/message/tracking/links/{trackingLinkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one tracking link of a confirmation email
      effect: read
      questions:
      - What URL does a specific tracked link in my confirmation email point to?
      - How often does one tracked link appear in the text version of the email?
      instructions:
      - text: Get tracking link {trackingLinkId} of confirmation mailing {confirmationMailId}.
        slots:
          trackingLinkId: path.trackingLinkId
          confirmationMailId: path.confirmationMailId
      - text: Show the URL and occurrences of tracking link {trackingLinkId} in confirmation mailing {confirmationMailId} for client {clientId}.
        slots:
          trackingLinkId: path.trackingLinkId
          confirmationMailId: path.confirmationMailId
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations/{confirmationMailId}/message/tracking/links/{trackingLinkId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Configure tracking for one email link
      effect: write
      questions:
      - Can I turn off click tracking for a single link in the HTML version only?
      - How do I attach click profiles to one tracked link in a confirmation email?
      instructions:
      - text: Set HTML tracking on link {trackingLinkId} of client {clientId}'s confirmation mailing {confirmationMailId} to {htmlTracking}.
        slots:
          trackingLinkId: path.trackingLinkId
          clientId: path.clientId
          confirmationMailId: path.confirmationMailId
          htmlTracking: requestBody.htmlTracking
      - text: Assign click profiles {clickProfileIds} to tracking link {trackingLinkId} in confirmation mailing {confirmationMailId}.
        slots:
          clickProfileIds: requestBody.clickProfileIds
          trackingLinkId: path.trackingLinkId
          confirmationMailId: path.confirmationMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations/{confirmationMailId}/message/tracking/links'].get
  update:
    x-apievangelist-phrasing:
      intent: List tracking links of a confirmation email
      effect: read
      questions:
      - Which links in my confirmation email are being tracked?
      - What are all the tracked URLs in a confirmation mailing and their IDs?
      instructions:
      - text: List all tracking links in confirmation mailing {confirmationMailId}.
        slots:
          confirmationMailId: path.confirmationMailId
      - text: Show every tracked URL for client {clientId}'s confirmation mailing {confirmationMailId}.
        slots:
          clientId: path.clientId
          confirmationMailId: path.confirmationMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations/{confirmationMailId}/message/tracking'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a confirmation email's tracking settings
      effect: read
      questions:
      - Is open tracking switched on for my confirmation email?
      - What are the overall click and open tracking settings of a confirmation mailing?
      instructions:
      - text: Show the tracking configuration of confirmation mailing {confirmationMailId}.
        slots:
          confirmationMailId: path.confirmationMailId
      - text: Check whether open and click tracking are enabled on confirmation mailing {confirmationMailId} for client {clientId}.
        slots:
          confirmationMailId: path.confirmationMailId
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations/{confirmationMailId}/message/tracking'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a confirmation email's tracking settings
      effect: write
      questions:
      - How do I turn on open tracking for an entire confirmation mailing?
      - Can I disable click tracking across all links of a confirmation email?
      instructions:
      - text: Set open tracking on client {clientId}'s confirmation mailing {confirmationMailId} to {openTrackingEnabled}.
        slots:
          clientId: path.clientId
          confirmationMailId: path.confirmationMailId
          openTrackingEnabled: requestBody.openTrackingEnabled
      - text: Set click tracking for confirmation mailing {confirmationMailId} to {clickTrackingEnabled}.
        slots:
          confirmationMailId: path.confirmationMailId
          clickTrackingEnabled: requestBody.clickTrackingEnabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations/{confirmationMailId}/recipientLists'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a confirmation mailing's Recipients node
      effect: read
      questions:
      - Which recipient lists feed a confirmation mailing's Recipients node?
      - What node follows the Recipients step in my confirmation mailing flow?
      instructions:
      - text: Get the Recipients node of confirmation mailing {confirmationMailId}.
        slots:
          confirmationMailId: path.confirmationMailId
      - text: Show the recipient node ID and successor for client {clientId}'s confirmation mailing {confirmationMailId}.
        slots:
          clientId: path.clientId
          confirmationMailId: path.confirmationMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations/{confirmationMailId}/recipientLists'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the recipient lists of a confirmation mailing
      effect: write
      questions:
      - How do I change which recipient lists a confirmation mailing targets?
      - Can I create the Recipients node for a confirmation mailing if it does not exist yet?
      instructions:
      - text: Point the Recipients node of client {clientId}'s confirmation mailing {confirmationMailId} at recipient lists {recipientListIds}.
        slots:
          clientId: path.clientId
          confirmationMailId: path.confirmationMailId
          recipientListIds: requestBody.recipientListIds
      - text: Create a Recipients node on confirmation mailing {confirmationMailId} with lists {recipientListIds} followed by node {successorNodeId}.
        slots:
          confirmationMailId: path.confirmationMailId
          recipientListIds: requestBody.recipientListIds
          successorNodeId: requestBody.successorNodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations/{confirmationMailId}/test/{testMailingId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a confirmation mailing's test send report
      effect: read
      questions:
      - Where can I check the delivery status of a test send made for a confirmation mailing itself?
      - Did any recipients fail in the mailing-level test report of a confirmation mailing?
      instructions:
      - text: Get the mailing-level test report {testMailingId} for confirmation mailing {confirmationMailId}.
        slots:
          testMailingId: path.testMailingId
          confirmationMailId: path.confirmationMailId
      - text: Show who was sent, enqueued or failed in test {testMailingId} of client {clientId}'s confirmation mailing {confirmationMailId}.
        slots:
          testMailingId: path.testMailingId
          clientId: path.clientId
          confirmationMailId: path.confirmationMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations/{confirmationMailId}/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test of a confirmation mailing
      effect: write
      questions:
      - How do I send a test of my confirmation email to a few people before going live?
      - Can I override the subject line when sending a test confirmation mailing?
      instructions:
      - text: Send a test of client {clientId}'s confirmation mailing {confirmationMailId} to recipients {recipientIds} from list {recipientListId}.
        slots:
          clientId: path.clientId
          confirmationMailId: path.confirmationMailId
          recipientIds: requestBody.recipientIds
          recipientListId: requestBody.recipientListId
      - text: Test-send confirmation mailing {confirmationMailId} to {recipientIds} in list {recipientListId} with subject {subject}.
        slots:
          confirmationMailId: path.confirmationMailId
          recipientIds: requestBody.recipientIds
          recipientListId: requestBody.recipientListId
          subject: requestBody.subject
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations/{confirmationMailId}/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a confirmation mailing's performance report
      effect: read
      questions:
      - How many opens, clicks and bounces has my confirmation email had?
      - What is the unsubscribe count for a confirmation mailing?
      instructions:
      - text: Get the campaign report for confirmation mailing {confirmationMailId}.
        slots:
          confirmationMailId: path.confirmationMailId
      - text: Show recipients, opens, clicks and bounces for client {clientId}'s confirmation mailing {confirmationMailId}.
        slots:
          clientId: path.clientId
          confirmationMailId: path.confirmationMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations/{confirmationMailId}/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a confirmation mailing
      effect: write
      questions:
      - How do I activate a confirmation mailing so it starts sending?
      - Can I switch on a confirmation mailing once it is ready?
      instructions:
      - text: Start confirmation mailing {confirmationMailId}.
        slots:
          confirmationMailId: path.confirmationMailId
      - text: Activate client {clientId}'s confirmation mailing {confirmationMailId}.
        slots:
          clientId: path.clientId
          confirmationMailId: path.confirmationMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/confirmations/{confirmationMailId}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a confirmation mailing
      effect: write
      questions:
      - How do I pause a running confirmation mailing so it stops sending?
      - Can I halt a confirmation mailing that is currently active?
      instructions:
      - text: Stop confirmation mailing {confirmationMailId}.
        slots:
          confirmationMailId: path.confirmationMailId
      - text: Halt sending of client {clientId}'s confirmation mailing {confirmationMailId}.
        slots:
          clientId: path.clientId
          confirmationMailId: path.confirmationMailId
      method: generated
      generated: '2026-09-26'