# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Optimizely Smart Campaigns API
  version: 1.0.0
extends: openapi/optimizely-smart-campaigns-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: 65
- target: $.paths['/{clientId}/smartcampaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: List smart campaigns for a Campaign client
      effect: read
      questions:
      - Which smart campaigns exist under my Optimizely Campaign client?
      - Can I see every automated smart campaign set up for one client account?
      instructions:
      - text: List all smart campaigns for client {clientId}.
        slots:
          clientId: path.clientId
      - text: Show me every smart campaign configured in Campaign client {clientId}.
        slots:
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new smart campaign or copy an existing one
      effect: write
      questions:
      - How do I create a new smart campaign through the API?
      - Can I duplicate an existing smart campaign instead of building it from scratch?
      - Is it possible to attach recipient lists while creating a smart campaign?
      instructions:
      - text: Create a smart campaign named {name} in client {clientId}.
        slots:
          name: requestBody.name
          clientId: path.clientId
      - text: Copy smart campaign {sourceCampaignId} into a new campaign in client {clientId}.
        slots:
          sourceCampaignId: requestBody.sourceCampaignId
          clientId: path.clientId
      - text: Start a new smart campaign {name} targeting recipient lists {recipientListIds}.
        slots:
          name: requestBody.name
          recipientListIds: requestBody.recipientListIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one smart campaign
      effect: read
      questions:
      - What are the details and current status of a particular smart campaign?
      - Can I look up a single smart campaign by its ID?
      instructions:
      - text: Get smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Show the details of smart campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename a smart campaign
      effect: write
      questions:
      - How do I rename a smart campaign after it's been created?
      - Can I change the name of an existing smart campaign?
      instructions:
      - text: Rename smart campaign {campaignId} in client {clientId} to {name}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
          name: requestBody.name
      - text: Change the title of smart campaign {campaignId} to {name}.
        slots:
          campaignId: path.campaignId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a smart campaign
      effect: destructive
      questions:
      - How do I permanently remove a smart campaign I no longer need?
      - Can a smart campaign be deleted through the API?
      instructions:
      - text: Delete smart campaign {campaignId} from client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Remove the smart campaign {campaignId} entirely.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a smart campaign's automated workflow
      effect: write
      questions:
      - How do I kick off the automated workflow of a smart campaign?
      - What call begins execution of a smart campaign?
      instructions:
      - text: Start smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Begin running the automated workflow for smart campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause a running smart campaign
      effect: write
      questions:
      - Can I temporarily pause a whole smart campaign without cancelling it?
      - How do I put a running smart campaign on hold?
      instructions:
      - text: Pause smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Put the entire smart campaign {campaignId} on hold.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a smart campaign
      effect: write
      questions:
      - How do I move a smart campaign into the Activated status?
      - What makes a smart campaign ready so its mailings can be started?
      instructions:
      - text: Activate smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Set smart campaign {campaignId} to status Activated.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/deactivate'].post
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a smart campaign
      effect: write
      questions:
      - How do I deactivate a smart campaign so it goes back to activation required?
      - Can I take a smart campaign out of the Activated state?
      instructions:
      - text: Deactivate smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Return smart campaign {campaignId} to the activation required status.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/abtest'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a smart campaign's A/B test node
      effect: read
      questions:
      - What optimization mode is the A/B test in my smart campaign using?
      - When is the A/B test node of a smart campaign scheduled to pick a winner, and what's its fallback?
      instructions:
      - text: Show the A/B test node settings for smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Get the split test configuration of smart campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/abtest'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a smart campaign's A/B test node
      effect: write
      questions:
      - How do I add an A/B test step to a smart campaign?
      - Can the A/B test pick a winner automatically by best open rate or click rate?
      - Is send time optimization available on an A/B test node?
      instructions:
      - text: Add an A/B test node to smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Set the A/B test in campaign {campaignId} to optimize by {mode} and dispatch the winner at {scheduledAt}.
        slots:
          campaignId: path.campaignId
          mode: requestBody.optimization.mode
          scheduledAt: requestBody.optimization.scheduledAt
      - text: Enable automatic optimization on the A/B test node of campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/abtest'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a smart campaign's A/B test node
      effect: destructive
      questions:
      - How do I remove the A/B test step from a smart campaign?
      - Can I drop split testing from a smart campaign's workflow?
      instructions:
      - text: Delete the A/B test node from smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Remove split testing from campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/abtest/successors/{nodeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one connection leaving an A/B test node
      effect: read
      questions:
      - What share of recipients does a specific branch out of my A/B test receive?
      - Which target group is attached to one particular A/B test connection?
      instructions:
      - text: Show the A/B test connection to node {nodeId} in smart campaign {campaignId} for client {clientId}.
        slots:
          nodeId: path.nodeId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Get the recipient split for the A/B branch leading to node {nodeId}.
        slots:
          nodeId: path.nodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/abtest/successors/{nodeId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a connection from an A/B test node
      effect: write
      questions:
      - How do I route a percentage of A/B test recipients to a particular next step?
      - Can I send a fixed number of recipients down one A/B test branch?
      - Is it possible to attach a target group to an A/B test connection?
      instructions:
      - text: Connect the A/B test in campaign {campaignId} to node {nodeId} for {relative} percent of recipients, client {clientId}.
        slots:
          campaignId: path.campaignId
          nodeId: path.nodeId
          relative: requestBody.relative
          clientId: path.clientId
      - text: Send {absolute} recipients from the A/B test down the branch to node {nodeId}.
        slots:
          absolute: requestBody.absolute
          nodeId: path.nodeId
      - text: Name the A/B branch to node {nodeId} as target group {name}.
        slots:
          nodeId: path.nodeId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/abtest/successors/{nodeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one connection leaving an A/B test node
      effect: destructive
      questions:
      - How do I remove a single branch from an A/B test node?
      - Can I disconnect the A/B test from just one of its next steps?
      instructions:
      - text: Delete the A/B test connection to node {nodeId} in smart campaign {campaignId}, client {clientId}.
        slots:
          nodeId: path.nodeId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Cut only the A/B branch that leads to node {nodeId}.
        slots:
          nodeId: path.nodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/abtest/successors'].get
  update:
    x-apievangelist-phrasing:
      intent: List all connections leaving an A/B test node
      effect: read
      questions:
      - Where do all the branches of my A/B test lead and how are recipients divided?
      - Can I see every outgoing connection from a smart campaign's A/B test at once?
      instructions:
      - text: List every connection out of the A/B test in smart campaign {campaignId} for client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Show all A/B test branches and their recipient shares for campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/abtest/successors'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all connections leaving an A/B test node
      effect: destructive
      questions:
      - How do I clear every outgoing branch from an A/B test node at once?
      - Can I disconnect the A/B test from all of its next steps in one call?
      instructions:
      - text: Remove all connections from the A/B test in smart campaign {campaignId}, client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Wipe every A/B branch out of campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/analysis'].get
  update:
    x-apievangelist-phrasing:
      intent: Get recipient analysis results of a smart campaign
      effect: read
      questions:
      - How many mailing recipients did the recipient analysis of my smart campaign find?
      - What state is the recipient analysis of a smart campaign in right now?
      instructions:
      - text: Show the recipient analysis data for smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Check the analysis status and recipient count for campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/analysis'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a recipient analysis for a smart campaign
      effect: write
      questions:
      - How do I trigger a fresh recipient analysis on a smart campaign?
      - Can I queue a new count of who a smart campaign would reach?
      instructions:
      - text: Schedule a new recipient analysis for smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Run a recipient analysis on campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/analysis'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running recipient analysis
      effect: destructive
      questions:
      - How do I stop a recipient analysis that is still running on a smart campaign?
      - Can an in-progress smart campaign analysis be cancelled?
      instructions:
      - text: Cancel the running recipient analysis of smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Abort the analysis currently in progress for campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/block'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a smart campaign's Block node
      effect: read
      questions:
      - Which custom blacklists does the Block step of my smart campaign use?
      - What does the Block node in a smart campaign filter out?
      instructions:
      - text: Show the Block node of smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Get the blacklist IDs used by the Block step of campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/block'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a smart campaign's Block node
      effect: write
      questions:
      - How do I exclude recipients on a custom blacklist from a smart campaign?
      - Can I add a Block step between two nodes of a smart campaign?
      instructions:
      - text: Add a Block node using blacklists {customBlacklistIds} to smart campaign {campaignId} in client {clientId}.
        slots:
          customBlacklistIds: requestBody.customBlacklistIds
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Place the Block step of campaign {campaignId} after node {predecessorNodeId}.
        slots:
          campaignId: path.campaignId
          predecessorNodeId: requestBody.predecessorNodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/block'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a smart campaign's Block node
      effect: destructive
      questions:
      - How do I remove the blacklist Block step from a smart campaign?
      - Can I stop a smart campaign from blocking blacklisted recipients?
      instructions:
      - text: Delete the Block node from smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Drop the blacklist Block step from campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/cap'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a smart campaign's Limit node
      effect: read
      questions:
      - How many recipients is my smart campaign capped at?
      - What recipient limit does the Limit node of a smart campaign apply?
      instructions:
      - text: Show the Limit node of smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Get the recipient cap set on campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/cap'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a smart campaign's Limit node
      effect: write
      questions:
      - How do I cap a smart campaign at a fixed number of recipients?
      - Can I limit a smart campaign to a percentage of its audience?
      instructions:
      - text: Limit smart campaign {campaignId} in client {clientId} to {absolute} recipients.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
          absolute: requestBody.absolute
      - text: Cap campaign {campaignId} at {relative} percent of recipients.
        slots:
          campaignId: path.campaignId
          relative: requestBody.relative
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/cap'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a smart campaign's Limit node
      effect: destructive
      questions:
      - How do I remove the recipient cap from a smart campaign?
      - Can I take the Limit step out of a smart campaign workflow?
      instructions:
      - text: Delete the Limit node from smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Remove the recipient cap on campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: List all mailings in a smart campaign
      effect: read
      questions:
      - Which mailings belong to my smart campaign?
      - Can I see every email and push message inside one smart campaign?
      instructions:
      - text: List all mailings of smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Show every message defined in campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a mailing in a smart campaign
      effect: write
      questions:
      - How do I add a new email mailing to a smart campaign?
      - Can a smart campaign mailing be a Web Push or Mobile Push message?
      - What sender details can I set when creating a campaign mailing?
      instructions:
      - text: Add a {mediaType} message called {name} to the workflow of smart campaign {campaignId}, client {clientId}.
        slots:
          mediaType: requestBody.mediaType
          name: requestBody.name
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Add a new mailing to campaign {campaignId} with subject {subject} from {senderAddress}.
        slots:
          campaignId: path.campaignId
          subject: requestBody.subject
          senderAddress: requestBody.senderAddress
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one smart campaign mailing
      effect: read
      questions:
      - What status and format is a particular campaign mailing in?
      - When was a specific smart campaign mailing created?
      instructions:
      - text: Get mailing {mailingId} of smart campaign {campaignId} in client {clientId}.
        slots:
          mailingId: path.mailingId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Show the status and type of mailing {mailingId}.
        slots:
          mailingId: path.mailingId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a smart campaign mailing
      effect: write
      questions:
      - How do I change the subject line of a mailing already in a smart campaign?
      - Can I update the sender name or reply-to address of an existing campaign mailing?
      instructions:
      - text: Change the subject of mailing {mailingId} in smart campaign {campaignId}, client {clientId}, to {subject}.
        slots:
          mailingId: path.mailingId
          campaignId: path.campaignId
          clientId: path.clientId
          subject: requestBody.subject
      - text: Set the sender name of existing mailing {mailingId} to {senderName}.
        slots:
          mailingId: path.mailingId
          senderName: requestBody.senderName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a smart campaign mailing
      effect: destructive
      questions:
      - How do I delete a mailing I created in a smart campaign?
      - Can one message be removed from a smart campaign without deleting the campaign?
      instructions:
      - text: Delete mailing {mailingId} from smart campaign {campaignId} in client {clientId}.
        slots:
          mailingId: path.mailingId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Remove the mailing {mailingId} from its campaign.
        slots:
          mailingId: path.mailingId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Add attachments to a campaign email
      effect: write
      questions:
      - How do I attach files to an email in a smart campaign?
      - Can I add several attachments to a campaign mailing in one request?
      instructions:
      - text: Attach files {attachmentIds} to mailing {mailingId} in smart campaign {campaignId}, client {clientId}.
        slots:
          attachmentIds: requestBody.attachmentIds
          mailingId: path.mailingId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Add attachment {attachmentIds} to the email {mailingId}.
        slots:
          attachmentIds: requestBody.attachmentIds
          mailingId: path.mailingId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/attachments'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove attachments from a campaign email
      effect: destructive
      questions:
      - How do I take attachments off a smart campaign email?
      - Can I detach specific files from a campaign mailing?
      instructions:
      - text: Remove attachments {attachmentIds} from mailing {mailingId} in smart campaign {campaignId}, client {clientId}.
        slots:
          attachmentIds: query.attachmentIds
          mailingId: path.mailingId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Detach file {attachmentIds} from email {mailingId}.
        slots:
          attachmentIds: query.attachmentIds
          mailingId: path.mailingId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/content'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the content of a campaign email
      effect: read
      questions:
      - How do I download the HTML or plain-text body of a campaign email?
      - Can I choose which content type of a mailing's content is returned?
      instructions:
      - text: Get the content of mailing {mailingId} in smart campaign {campaignId}, client {clientId}.
        slots:
          mailingId: path.mailingId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Fetch the body of email {mailingId} as {Accept}.
        slots:
          mailingId: path.mailingId
          Accept: header.Accept
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/content'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload new content for a campaign mailing
      effect: write
      questions:
      - How do I replace the HTML body of a smart campaign mailing?
      - Can I upload multipart content with both HTML and plain text for a mailing?
      instructions:
      - text: Upload {content} as the body of mailing {mailingId} in smart campaign {campaignId}, client {clientId}.
        slots:
          content: requestBody.content
          mailingId: path.mailingId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Replace the content of mailing {mailingId} with new HTML.
        slots:
          mailingId: path.mailingId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/content'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear the content of a campaign email
      effect: destructive
      questions:
      - How do I wipe the body content of a campaign email and start over?
      - Can I empty a mailing's content without deleting the mailing itself?
      instructions:
      - text: Delete the content of mailing {mailingId} in smart campaign {campaignId}, client {clientId}.
        slots:
          mailingId: path.mailingId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Clear out the email body of mailing {mailingId}.
        slots:
          mailingId: path.mailingId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/test/{testMailingId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the sending status of a test mailing
      effect: read
      questions:
      - Did my test mailing actually reach each test recipient?
      - Which recipients of a test send are still enqueued or failed?
      instructions:
      - text: Show the delivery status of test {testMailingId} for mailing {mailingId} in campaign {campaignId}, client {clientId}.
        slots:
          testMailingId: path.testMailingId
          mailingId: path.mailingId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Report which recipients of test send {testMailingId} were sent or failed.
        slots:
          testMailingId: path.testMailingId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test of a campaign mailing
      effect: write
      questions:
      - How do I send a test version of a mailing before the real send?
      - Can I override the subject or sender address just for a test send?
      instructions:
      - text: Send a test of mailing {mailingId} in campaign {campaignId}, client {clientId}, to recipients {recipientIds} from list {recipientListId}.
        slots:
          mailingId: path.mailingId
          campaignId: path.campaignId
          clientId: path.clientId
          recipientIds: requestBody.recipientIds
          recipientListId: requestBody.recipientListId
      - text: Test-send mailing {mailingId} with subject {subject} to recipients {recipientIds} in list {recipientListId}.
        slots:
          mailingId: path.mailingId
          subject: requestBody.subject
          recipientIds: requestBody.recipientIds
          recipientListId: requestBody.recipientListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/tracking/links/{trackingLinkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one tracking link of a mailing
      effect: read
      questions:
      - What URL does a particular tracking link in my mailing point to?
      - How often does one tracked link appear in a mailing's text version?
      instructions:
      - text: Show tracking link {trackingLinkId} of mailing {mailingId} in campaign {campaignId}, client {clientId}.
        slots:
          trackingLinkId: path.trackingLinkId
          mailingId: path.mailingId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Get the URL behind tracked link {trackingLinkId}.
        slots:
          trackingLinkId: path.trackingLinkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/tracking/links/{trackingLinkId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update tracking on one link of a mailing
      effect: write
      questions:
      - How do I turn off click tracking for a single link in a mailing?
      - Can I assign click profiles to a specific tracked link?
      instructions:
      - text: Set HTML tracking of link {trackingLinkId} in mailing {mailingId}, campaign {campaignId}, client {clientId} to {htmlTracking}.
        slots:
          trackingLinkId: path.trackingLinkId
          mailingId: path.mailingId
          campaignId: path.campaignId
          clientId: path.clientId
          htmlTracking: requestBody.htmlTracking
      - text: Attach click profiles {clickProfileIds} to tracked link {trackingLinkId}.
        slots:
          clickProfileIds: requestBody.clickProfileIds
          trackingLinkId: path.trackingLinkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/tracking/links'].get
  update:
    x-apievangelist-phrasing:
      intent: List all tracking links of a mailing
      effect: read
      questions:
      - Which links in my campaign mailing are being tracked?
      - Can I get every tracked URL in a mailing at once?
      instructions:
      - text: List all tracking links in mailing {mailingId} of campaign {campaignId}, client {clientId}.
        slots:
          mailingId: path.mailingId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Show every tracked URL in mailing {mailingId}.
        slots:
          mailingId: path.mailingId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/tracking'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a mailing's open and click tracking settings
      effect: read
      questions:
      - Is open tracking switched on for my campaign mailing?
      - What are the overall tracking defaults of a mailing?
      instructions:
      - text: Show the tracking configuration of mailing {mailingId} in campaign {campaignId}, client {clientId}.
        slots:
          mailingId: path.mailingId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Check whether opens and clicks are tracked for mailing {mailingId}.
        slots:
          mailingId: path.mailingId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/tracking'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a mailing's open and click tracking settings
      effect: write
      questions:
      - How do I enable open tracking for a whole mailing?
      - Can I stop tracking clicks across an entire campaign mailing?
      - Is there a setting to count opens of partially loaded messages?
      instructions:
      - text: Set open tracking for mailing {mailingId} in campaign {campaignId}, client {clientId} to {openTrackingEnabled}.
        slots:
          mailingId: path.mailingId
          campaignId: path.campaignId
          clientId: path.clientId
          openTrackingEnabled: requestBody.openTrackingEnabled
      - text: Turn click tracking for all of mailing {mailingId} to {clickTrackingEnabled}.
        slots:
          mailingId: path.mailingId
          clickTrackingEnabled: requestBody.clickTrackingEnabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause one mailing in a smart campaign
      effect: write
      questions:
      - How do I pause a single mailing without pausing the whole smart campaign?
      - Can I hold back one message in a smart campaign temporarily?
      instructions:
      - text: Pause mailing {mailingId} in smart campaign {campaignId}, client {clientId}.
        slots:
          mailingId: path.mailingId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Hold just the message {mailingId} for now.
        slots:
          mailingId: path.mailingId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start one mailing in a smart campaign
      effect: write
      questions:
      - How do I start sending one mailing of a smart campaign?
      - Does the smart campaign need to be activated before I can start one of its mailings?
      instructions:
      - text: Start mailing {mailingId} in smart campaign {campaignId}, client {clientId}.
        slots:
          mailingId: path.mailingId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Begin sending the single message {mailingId}.
        slots:
          mailingId: path.mailingId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop one mailing in a smart campaign
      effect: destructive
      questions:
      - How do I stop one mailing in a smart campaign for good?
      - Can a single campaign message be stopped while the rest keep running?
      instructions:
      - text: Stop mailing {mailingId} in smart campaign {campaignId}, client {clientId}.
        slots:
          mailingId: path.mailingId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Halt the message {mailingId} permanently.
        slots:
          mailingId: path.mailingId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/recipientLists'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a smart campaign's Recipients node
      effect: read
      questions:
      - Which recipient lists feed the start of my smart campaign?
      - Where does the Recipients node sit in a smart campaign's grid?
      instructions:
      - text: Show the Recipients node of smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Get the recipient lists used as the audience of campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/recipientLists'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the recipient lists of a smart campaign
      effect: write
      questions:
      - How do I change which recipient lists a smart campaign sends to?
      - Can I point a smart campaign's Recipients node at several lists?
      instructions:
      - text: Set smart campaign {campaignId} in client {clientId} to use recipient lists {recipientListIds}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
          recipientListIds: requestBody.recipientListIds
      - text: Update the Recipients node of campaign {campaignId} to lists {recipientListIds}.
        slots:
          campaignId: path.campaignId
          recipientListIds: requestBody.recipientListIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List all Wait nodes of a smart campaign
      effect: read
      questions:
      - What waiting periods are built into my smart campaign?
      - Can I see all the delay steps of a smart campaign together?
      instructions:
      - text: List every Wait node in smart campaign {campaignId} for client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Show all delay steps configured in campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a Wait node to a smart campaign
      effect: write
      questions:
      - How do I add a delay step to a smart campaign?
      - Can a smart campaign wait until after a recipient import before continuing?
      instructions:
      - text: Add a Wait node scheduled at {scheduledAt} to smart campaign {campaignId} in client {clientId}.
        slots:
          scheduledAt: requestBody.scheduledAt
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Insert a new delay step after node {predecessorNodeId} in campaign {campaignId}.
        slots:
          predecessorNodeId: requestBody.predecessorNodeId
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/schedules/{waitNodeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Wait node of a smart campaign
      effect: read
      questions:
      - How long does a particular Wait step in my smart campaign pause for?
      - What is the fallback time of one specific delay node?
      instructions:
      - text: Show Wait node {waitNodeId} of smart campaign {campaignId} in client {clientId}.
        slots:
          waitNodeId: path.waitNodeId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Get the delay period of wait step {waitNodeId}.
        slots:
          waitNodeId: path.waitNodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/schedules/{waitNodeId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a Wait node in a smart campaign
      effect: write
      questions:
      - How do I change when an existing Wait step in a smart campaign fires?
      - Can I turn on send time optimization for a delay node I already created?
      instructions:
      - text: Reschedule Wait node {waitNodeId} in smart campaign {campaignId}, client {clientId}, to {scheduledAt}.
        slots:
          waitNodeId: path.waitNodeId
          campaignId: path.campaignId
          clientId: path.clientId
          scheduledAt: requestBody.scheduledAt
      - text: Set send time optimization on existing wait step {waitNodeId} to {enabled}.
        slots:
          waitNodeId: path.waitNodeId
          enabled: requestBody.sto.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/schedules/{waitNodeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Wait node from a smart campaign
      effect: destructive
      questions:
      - How do I remove a delay step from a smart campaign?
      - Can I delete one specific Wait node?
      instructions:
      - text: Delete Wait node {waitNodeId} from smart campaign {campaignId} in client {clientId}.
        slots:
          waitNodeId: path.waitNodeId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Remove the wait step {waitNodeId}.
        slots:
          waitNodeId: path.waitNodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/targetGroups'].get
  update:
    x-apievangelist-phrasing:
      intent: List all Target groups nodes of a smart campaign
      effect: read
      questions:
      - Which target groups split the audience of my smart campaign?
      - Can I see all the audience segmentation steps in a smart campaign?
      instructions:
      - text: List every Target groups node in smart campaign {campaignId} for client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Show all target group filters used in campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/targetGroups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a Target groups node
      effect: write
      questions:
      - How do I segment a smart campaign's recipients by target group?
      - Can I insert a target group filter between two campaign steps?
      instructions:
      - text: Add a Target groups node named {name} to smart campaign {campaignId} in client {clientId}.
        slots:
          name: requestBody.name
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Filter campaign {campaignId} by target group definition {targetGroup}.
        slots:
          campaignId: path.campaignId
          targetGroup: requestBody.targetGroup
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/targetGroups'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all Target groups nodes of a smart campaign
      effect: destructive
      questions:
      - How do I clear every target group filter from a smart campaign at once?
      - Can I remove all audience segmentation nodes in one call?
      instructions:
      - text: Delete all Target groups nodes from smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Wipe every target group filter out of campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/targetGroups/{filterNodeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Target groups node of a smart campaign
      effect: read
      questions:
      - What target group does one specific filter node in my campaign use?
      - Which node follows a particular target group step?
      instructions:
      - text: Show Target groups node {filterNodeId} of smart campaign {campaignId} in client {clientId}.
        slots:
          filterNodeId: path.filterNodeId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Get the target group behind filter node {filterNodeId}.
        slots:
          filterNodeId: path.filterNodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/targetGroups/{filterNodeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one Target groups node
      effect: destructive
      questions:
      - How do I remove only one target group filter from a smart campaign?
      - Can I delete a single segmentation node by its ID?
      instructions:
      - text: Delete Target groups node {filterNodeId} from smart campaign {campaignId} in client {clientId}.
        slots:
          filterNodeId: path.filterNodeId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Remove the single target group filter {filterNodeId}.
        slots:
          filterNodeId: path.filterNodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/throttles'].get
  update:
    x-apievangelist-phrasing:
      intent: List all Throttle nodes of a smart campaign
      effect: read
      questions:
      - What sending-rate limits are set across my smart campaign?
      - Can I see all the Throttle steps in one smart campaign?
      instructions:
      - text: List every Throttle node in smart campaign {campaignId} for client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Show all messages-per-hour limits in campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/throttles'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a Throttle node to a smart campaign
      effect: write
      questions:
      - How do I limit how many messages per hour a smart campaign sends?
      - Can I add a new throttling step to slow down a campaign's sending?
      instructions:
      - text: Add a Throttle node of {maxMessagesPerHour} messages per hour to smart campaign {campaignId} in client {clientId}.
        slots:
          maxMessagesPerHour: requestBody.maxMessagesPerHour
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Insert a new throttle after node {predecessorNodeId} in campaign {campaignId}.
        slots:
          predecessorNodeId: requestBody.predecessorNodeId
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/throttles/{throttleNodeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Throttle node of a smart campaign
      effect: read
      questions:
      - What hourly sending limit does a particular Throttle step apply?
      - Which node comes after one specific throttle in my campaign?
      instructions:
      - text: Show Throttle node {throttleNodeId} of smart campaign {campaignId} in client {clientId}.
        slots:
          throttleNodeId: path.throttleNodeId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Get the messages-per-hour cap of throttle {throttleNodeId}.
        slots:
          throttleNodeId: path.throttleNodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/throttles/{throttleNodeId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a Throttle node in a smart campaign
      effect: write
      questions:
      - How do I raise or lower the hourly limit on an existing Throttle step?
      - Can I move an existing throttle to a different spot in the campaign?
      instructions:
      - text: Change Throttle node {throttleNodeId} in smart campaign {campaignId}, client {clientId}, to {maxMessagesPerHour} per hour.
        slots:
          throttleNodeId: path.throttleNodeId
          campaignId: path.campaignId
          clientId: path.clientId
          maxMessagesPerHour: requestBody.maxMessagesPerHour
      - text: Reconnect existing throttle {throttleNodeId} to successor node {successorNodeId}.
        slots:
          throttleNodeId: path.throttleNodeId
          successorNodeId: requestBody.successorNodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/throttles/{throttleNodeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Throttle node from a smart campaign
      effect: destructive
      questions:
      - How do I remove a sending-rate limit step from a smart campaign?
      - Can I delete one specific Throttle node?
      instructions:
      - text: Delete Throttle node {throttleNodeId} from smart campaign {campaignId} in client {clientId}.
        slots:
          throttleNodeId: path.throttleNodeId
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Remove the throttle {throttleNodeId}.
        slots:
          throttleNodeId: path.throttleNodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a smart campaign performance report
      effect: read
      questions:
      - How many opens, clicks and bounces did my smart campaign get?
      - What were the unsubscribes from a smart campaign?
      instructions:
      - text: Get the performance report for smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Show opens, clicks and bounces for campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/smartcampaigns/{campaignId}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a smart campaign
      effect: destructive
      questions:
      - How do I cancel a smart campaign that is running?
      - Is there a way to stop an entire smart campaign for good rather than pausing it?
      instructions:
      - text: Cancel smart campaign {campaignId} in client {clientId}.
        slots:
          campaignId: path.campaignId
          clientId: path.clientId
      - text: Stop the whole smart campaign {campaignId} permanently.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-09-26'