# 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 Transactional mails API
  version: 1.0.0
extends: openapi/optimizely-transactional-mails-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: 24
- target: $.paths['/{clientId}/transactionalmail'].get
  update:
    x-apievangelist-phrasing:
      intent: List all transactional mails
      effect: read
      questions:
      - How do I see every transactional mail set up in my Optimizely Campaign client?
      - Can I filter my transactional mails by status or media type such as email or SMS?
      - Which transactional mails sit in a particular folder?
      instructions:
      - text: List all transactional mails for client {clientId}.
        slots:
          clientId: path.clientId
      - text: Show the transactional mails for client {clientId} with status {status}.
        slots:
          clientId: path.clientId
          status: query.status
      - text: List transactional mails in folder {folderId} for client {clientId}, up to {limit} of them.
        slots:
          folderId: query.folderId
          clientId: path.clientId
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a transactional mail
      effect: write
      questions:
      - How do I set up a new transactional mail with a subject, sender and content?
      - Can a new transactional mail be tied to one or more recipient lists when I create it?
      - What do I need to supply to create a transactional mail from scratch?
      instructions:
      - text: 'Create a transactional mail for client {clientId} with subject {subject} sent from {senderAddress} to recipient lists {recipientListIds}, content: {content}.'
        slots:
          clientId: path.clientId
          subject: requestBody.subject
          senderAddress: requestBody.senderAddress
          recipientListIds: requestBody.recipientListIds
          content: requestBody.content
      - text: Set up a new transactional mail named {name} under client {clientId}.
        slots:
          name: requestBody.name
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one transactional mail
      effect: read
      questions:
      - What is the current status and type of a specific transactional mail?
      - When was a given transactional mail created?
      instructions:
      - text: Get the details of transactional mail {transactionalMailId} for client {clientId}.
        slots:
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
      - text: Look up the status of transactional mail {transactionalMailId}.
        slots:
          transactionalMailId: path.transactionalMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a transactional mail
      effect: destructive
      questions:
      - How do I permanently remove a transactional mail I no longer use?
      - Can I delete a transactional mail from my Campaign client?
      instructions:
      - text: Delete transactional mail {transactionalMailId} from client {clientId}.
        slots:
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
      - text: Remove the transactional mail {transactionalMailId}.
        slots:
          transactionalMailId: path.transactionalMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}/message'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a transactional mail's message settings
      effect: write
      questions:
      - How do I change the subject or sender of an existing transactional mail?
      - Can I edit the name, reply-to address or push settings of a transactional mail's message?
      - Is it possible to reset all target-group subjects on a transactional mail?
      instructions:
      - text: Change the subject of transactional mail {transactionalMailId} for client {clientId} to {subject}.
        slots:
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
          subject: requestBody.subject
      - text: Set the sender address of transactional mail {transactionalMailId} to {senderAddress} and the sender name to {senderName}.
        slots:
          transactionalMailId: path.transactionalMailId
          senderAddress: requestBody.senderAddress
          senderName: requestBody.senderName
      - text: Rename transactional mail {transactionalMailId} to {name}.
        slots:
          transactionalMailId: path.transactionalMailId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}/message/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach files to a transactional email
      effect: write
      questions:
      - How do I add attachments to a transactional email message?
      - Can I attach several files to a transactional mail at once?
      instructions:
      - text: Attach files {attachmentIds} to transactional mail {transactionalMailId} for client {clientId}.
        slots:
          attachmentIds: requestBody.attachmentIds
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
      - text: Add attachment {attachmentIds} to the email of transactional mail {transactionalMailId}.
        slots:
          attachmentIds: requestBody.attachmentIds
          transactionalMailId: path.transactionalMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}/message/attachments'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove attachments from a transactional email
      effect: destructive
      questions:
      - How do I take an attachment off a transactional email?
      - Can I detach multiple files from a transactional mail in one call?
      instructions:
      - text: Remove attachments {attachmentIds} from transactional mail {transactionalMailId} for client {clientId}.
        slots:
          attachmentIds: query.attachmentIds
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
      - text: Detach file {attachmentIds} from the transactional mail {transactionalMailId}.
        slots:
          attachmentIds: query.attachmentIds
          transactionalMailId: path.transactionalMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}/message/content'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the content of a transactional email
      effect: read
      questions:
      - Can I download the HTML or plain-text body of a transactional email?
      - Where do I read the current content of a transactional mail?
      instructions:
      - text: Fetch the email content of transactional mail {transactionalMailId} for client {clientId}.
        slots:
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
      - text: Get the body of transactional mail {transactionalMailId} as {Accept}.
        slots:
          transactionalMailId: path.transactionalMailId
          Accept: header.Accept
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}/message/content'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace the content of a transactional mail
      effect: write
      questions:
      - How do I upload new HTML or plain-text content for a transactional mail?
      - Can I send multipart content with both HTML and text for a transactional email?
      instructions:
      - text: Upload new content {content} to transactional mail {transactionalMailId} for client {clientId}.
        slots:
          content: requestBody.content
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
      - text: Replace the body of transactional mail {transactionalMailId} with this HTML.
        slots:
          transactionalMailId: path.transactionalMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}/message/test/{testMailingId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get recipient status of a test message send
      effect: read
      questions:
      - Did every recipient of my transactional message test actually get it?
      - Which test recipients are still enqueued versus sent under the message test endpoint?
      instructions:
      - text: Show the message-level test report {testMailingId} for transactional mail {transactionalMailId} in client {clientId}.
        slots:
          testMailingId: path.testMailingId
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
      - text: Check per-recipient sending status of message test {testMailingId} on transactional mail {transactionalMailId}.
        slots:
          testMailingId: path.testMailingId
          transactionalMailId: path.transactionalMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}/message/tracking/links/{trackingLinkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one tracking link of a transactional mail
      effect: read
      questions:
      - What URL does a specific tracking link in my transactional mail point to?
      - How many times does a particular tracked link appear in the text and HTML versions?
      instructions:
      - text: Get tracking link {trackingLinkId} of transactional mail {transactionalMailId} for client {clientId}.
        slots:
          trackingLinkId: path.trackingLinkId
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
      - text: Show the URL and occurrences of tracking link {trackingLinkId}.
        slots:
          trackingLinkId: path.trackingLinkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}/message/tracking/links/{trackingLinkId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change tracking for one link in a transactional mail
      effect: write
      questions:
      - Can I turn off click tracking for a single link in the HTML version of a transactional mail?
      - How do I assign click profiles to a specific tracked link?
      instructions:
      - text: Set HTML tracking of link {trackingLinkId} in transactional mail {transactionalMailId} for client {clientId} to {htmlTracking}.
        slots:
          trackingLinkId: path.trackingLinkId
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
          htmlTracking: requestBody.htmlTracking
      - text: Assign click profiles {clickProfileIds} to tracking link {trackingLinkId}.
        slots:
          clickProfileIds: requestBody.clickProfileIds
          trackingLinkId: path.trackingLinkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}/message/tracking/links'].get
  update:
    x-apievangelist-phrasing:
      intent: List all tracking links in a transactional mail
      effect: read
      questions:
      - Which links in my transactional mail are being tracked?
      - Can I get every tracking link with its URL for a transactional mail?
      instructions:
      - text: List all tracking links in transactional mail {transactionalMailId} for client {clientId}.
        slots:
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
      - text: Show every tracked URL in transactional mail {transactionalMailId}.
        slots:
          transactionalMailId: path.transactionalMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}/message/tracking'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transactional mail's tracking settings
      effect: read
      questions:
      - Is open and click tracking switched on for my transactional mail?
      - What are the default link tracking settings on a transactional mail?
      instructions:
      - text: Show the tracking configuration of transactional mail {transactionalMailId} for client {clientId}.
        slots:
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
      - text: Check whether opens and clicks are tracked on transactional mail {transactionalMailId}.
        slots:
          transactionalMailId: path.transactionalMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}/message/tracking'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a transactional mail's tracking settings
      effect: write
      questions:
      - How do I enable open tracking for a transactional mail?
      - Can I turn click tracking off for the whole transactional mail?
      - Is it possible to track opens of partially loaded messages?
      instructions:
      - text: Turn open tracking {openTrackingEnabled} on transactional mail {transactionalMailId} for client {clientId}.
        slots:
          openTrackingEnabled: requestBody.openTrackingEnabled
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
      - text: Set click tracking to {clickTrackingEnabled} for transactional mail {transactionalMailId}.
        slots:
          clickTrackingEnabled: requestBody.clickTrackingEnabled
          transactionalMailId: path.transactionalMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}/recipientLists'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Recipients node of a transactional mail
      effect: read
      questions:
      - Which recipient lists feed the Recipients node of my transactional mail?
      - What is the successor node after the Recipients node of a transactional mail?
      instructions:
      - text: Get the Recipients node of transactional mail {transactionalMailId} for client {clientId}.
        slots:
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
      - text: Show the recipient node and grid location for transactional mail {transactionalMailId}.
        slots:
          transactionalMailId: path.transactionalMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}/recipientLists'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the recipient lists of a transactional mail
      effect: write
      questions:
      - How do I change which recipient lists a transactional mail targets?
      - Can I create the Recipients node for a transactional mail and link a successor node?
      instructions:
      - text: Point the Recipients node of transactional mail {transactionalMailId} for client {clientId} at lists {recipientListIds}.
        slots:
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
          recipientListIds: requestBody.recipientListIds
      - text: Link the Recipients node of transactional mail {transactionalMailId} to successor node {successorNodeId}.
        slots:
          transactionalMailId: path.transactionalMailId
          successorNodeId: requestBody.successorNodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}/test/{testMailingId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get recipient status of a transactional test send
      effect: read
      questions:
      - How do I check the result of a test mailing I sent for a transactional mail?
      - Which recipients of my transactional mail test failed or are still sending?
      instructions:
      - text: Get the report for test send {testMailingId} of transactional mail {transactionalMailId} in client {clientId}.
        slots:
          testMailingId: path.testMailingId
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
      - text: Show sending status for each recipient of test {testMailingId} started on transactional mail {transactionalMailId}.
        slots:
          testMailingId: path.testMailingId
          transactionalMailId: path.transactionalMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test of a transactional mail
      effect: write
      questions:
      - Can I preview a transactional mail by sending a test to a few recipients first?
      - How do I send a test with a different subject or sender address?
      instructions:
      - text: Send a test of transactional mail {transactionalMailId} for client {clientId} to recipients {recipientIds} from list {recipientListId}.
        slots:
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
          recipientIds: requestBody.recipientIds
          recipientListId: requestBody.recipientListId
      - text: Test transactional mail {transactionalMailId} with subject {subject} for recipient {recipientIds} in list {recipientListId}.
        slots:
          transactionalMailId: path.transactionalMailId
          subject: requestBody.subject
          recipientIds: requestBody.recipientIds
          recipientListId: requestBody.recipientListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}/send'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a transactional mail to a recipient
      effect: write
      questions:
      - How do I trigger a transactional email like an order confirmation to one person?
      - Can I pass personalization data along when sending a transactional mail?
      - Is it possible to send a transactional message by SMS to a phone number?
      instructions:
      - text: Send transactional mail {transactionalMailId} for client {clientId} to {recipientId} via list {recipientListId}.
        slots:
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
          recipientId: requestBody.recipientId
          recipientListId: requestBody.recipientListId
      - text: Deliver transactional mail {transactionalMailId} to {recipientId} using recipient list {recipientListId} with attachment token {personalizedAttachmentsToken}.
        slots:
          transactionalMailId: path.transactionalMailId
          recipientId: requestBody.recipientId
          recipientListId: requestBody.recipientListId
          personalizedAttachmentsToken: requestBody.personalizedAttachmentsToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Get performance report of a transactional mail
      effect: read
      questions:
      - How many opens, clicks and bounces has my transactional mail had?
      - What does the campaign report say about a transactional mail's recipients?
      instructions:
      - text: Get the campaign report for transactional mail {transactionalMailId} in client {clientId}.
        slots:
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
      - text: Show opens, clicks and bounces for transactional mail {transactionalMailId}.
        slots:
          transactionalMailId: path.transactionalMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a transactional mail
      effect: write
      questions:
      - How do I activate a transactional mail so it can start sending?
      - Can I restart a transactional mail that I stopped earlier?
      instructions:
      - text: Start transactional mail {transactionalMailId} for client {clientId}.
        slots:
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
      - text: Activate the transactional mail {transactionalMailId}.
        slots:
          transactionalMailId: path.transactionalMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/{transactionalMailId}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a transactional mail
      effect: write
      questions:
      - How do I pause a transactional mail so it stops sending?
      - Can I halt a running transactional mail without deleting it?
      instructions:
      - text: Stop transactional mail {transactionalMailId} for client {clientId}.
        slots:
          transactionalMailId: path.transactionalMailId
          clientId: path.clientId
      - text: Halt sending of the transactional mail {transactionalMailId}.
        slots:
          transactionalMailId: path.transactionalMailId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/transactionalmail/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check delivery status of a sent transactional mail
      effect: read
      questions:
      - Was a transactional message I already sent actually delivered?
      - Where can I look up the sending status of one sent transactional mail by its mail ID?
      instructions:
      - text: Check the sending status of sent mail {mailId} for client {clientId}.
        slots:
          mailId: query.mailId
          clientId: path.clientId
      - text: Look up whether transactional send {mailId} went out.
        slots:
          mailId: query.mailId
      method: generated
      generated: '2026-09-26'