Optimizely

Optimizely Smart Campaigns API

Manage smart campaigns that automate multi-step marketing workflows.

GitHub OpenAPI
Business capability
Digital Marketing Management BC-400.60

Operations 65

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /{clientId}/smartcampaigns List smart campaigns for a Campaign client · List smart campaigns #
Ask an LLM
“Which smart campaigns exist under my Optimizely Campaign client?”
“Can I see every automated smart campaign set up for one client account?”
Tell an agent
List all smart campaigns for client {clientId}.
Show me every smart campaign configured in Campaign client {clientId}.
POST /{clientId}/smartcampaigns Create a new smart campaign or copy an existing one · Create or copy a Smart Campaign #
Ask an LLM
“How do I create a new smart campaign through the API?”
“Can I duplicate an existing smart campaign instead of building it from scratch?”
Tell an agent
Create a smart campaign named {name} in client {clientId}.
Copy smart campaign {sourceCampaignId} into a new campaign in client {clientId}.
GET /{clientId}/smartcampaigns/{campaignId} Get details of one smart campaign · Get a smart campaign #
Ask an LLM
“What are the details and current status of a particular smart campaign?”
“Can I look up a single smart campaign by its ID?”
Tell an agent
Get smart campaign {campaignId} in client {clientId}.
Show the details of smart campaign {campaignId}.
POST /{clientId}/smartcampaigns/{campaignId} Rename a smart campaign · Update the name of a Smart Campaign #
Ask an LLM
“How do I rename a smart campaign after it's been created?”
“Can I change the name of an existing smart campaign?”
Tell an agent
Rename smart campaign {campaignId} in client {clientId} to {name}.
Change the title of smart campaign {campaignId} to {name}.
DELETE /{clientId}/smartcampaigns/{campaignId} Delete a smart campaign · Delete a Smart Campaign #
Ask an LLM
“How do I permanently remove a smart campaign I no longer need?”
“Can a smart campaign be deleted through the API?”
Tell an agent destructive · confirm first
Delete smart campaign {campaignId} from client {clientId}.
Remove the smart campaign {campaignId} entirely.
POST /{clientId}/smartcampaigns/{campaignId}/start Start a smart campaign's automated workflow · Start a smart campaign #
Ask an LLM
“How do I kick off the automated workflow of a smart campaign?”
“What call begins execution of a smart campaign?”
Tell an agent
Start smart campaign {campaignId} in client {clientId}.
Begin running the automated workflow for smart campaign {campaignId}.
POST /{clientId}/smartcampaigns/{campaignId}/pause Pause a running smart campaign · Pause a smart campaign #
Ask an LLM
“Can I temporarily pause a whole smart campaign without cancelling it?”
“How do I put a running smart campaign on hold?”
Tell an agent
Pause smart campaign {campaignId} in client {clientId}.
Put the entire smart campaign {campaignId} on hold.
POST /{clientId}/smartcampaigns/{campaignId}/activate Activate a smart campaign · Activate a Smart Campaign #
Ask an LLM
“How do I move a smart campaign into the Activated status?”
“What makes a smart campaign ready so its mailings can be started?”
Tell an agent
Activate smart campaign {campaignId} in client {clientId}.
Set smart campaign {campaignId} to status Activated.
POST /{clientId}/smartcampaigns/{campaignId}/deactivate Deactivate a smart campaign · Deactivate a Smart Campaign #
Ask an LLM
“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?”
Tell an agent
Deactivate smart campaign {campaignId} in client {clientId}.
Return smart campaign {campaignId} to the activation required status.
GET /{clientId}/smartcampaigns/{campaignId}/abtest Get a smart campaign's A/B test node · Get information about a "A/B test" node of a Smart Campaign #
Ask an LLM
“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?”
Tell an agent
Show the A/B test node settings for smart campaign {campaignId} in client {clientId}.
Get the split test configuration of smart campaign {campaignId}.
POST /{clientId}/smartcampaigns/{campaignId}/abtest Create or update a smart campaign's A/B test node · Create or update an "A/B test" node of a Smart Campaign #
Ask an LLM
“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?”
Tell an agent
Add an A/B test node to smart campaign {campaignId} in client {clientId}.
Set the A/B test in campaign {campaignId} to optimize by {mode} and dispatch the winner at {scheduledAt}.
DELETE /{clientId}/smartcampaigns/{campaignId}/abtest Delete a smart campaign's A/B test node · Delete an "A/B test" node of a Smart Campaign #
Ask an LLM
“How do I remove the A/B test step from a smart campaign?”
“Can I drop split testing from a smart campaign's workflow?”
Tell an agent destructive · confirm first
Delete the A/B test node from smart campaign {campaignId} in client {clientId}.
Remove split testing from campaign {campaignId}.
GET /{clientId}/smartcampaigns/{campaignId}/abtest/successors/{nodeId} Get one connection leaving an A/B test node · Get information about a connection from an "A/B test" node #
Ask an LLM
“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?”
Tell an agent
Show the A/B test connection to node {nodeId} in smart campaign {campaignId} for client {clientId}.
Get the recipient split for the A/B branch leading to node {nodeId}.
POST /{clientId}/smartcampaigns/{campaignId}/abtest/successors/{nodeId} Create or update a connection from an A/B test node · Create or update a connection from a "A/B test" node #
Ask an LLM
“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?”
Tell an agent
Connect the A/B test in campaign {campaignId} to node {nodeId} for {relative} percent of recipients, client {clientId}.
Send {absolute} recipients from the A/B test down the branch to node {nodeId}.
DELETE /{clientId}/smartcampaigns/{campaignId}/abtest/successors/{nodeId} Delete one connection leaving an A/B test node · Delete a connection from a "A/B test" node to another node #
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Delete the A/B test connection to node {nodeId} in smart campaign {campaignId}, client {clientId}.
Cut only the A/B branch that leads to node {nodeId}.
GET /{clientId}/smartcampaigns/{campaignId}/abtest/successors List all connections leaving an A/B test node · Get information about all connections from an "A/B test" node #
Ask an LLM
“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?”
Tell an agent
List every connection out of the A/B test in smart campaign {campaignId} for client {clientId}.
Show all A/B test branches and their recipient shares for campaign {campaignId}.
DELETE /{clientId}/smartcampaigns/{campaignId}/abtest/successors Delete all connections leaving an A/B test node · Delete all connections from the "A/B test" node to other nodes #
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Remove all connections from the A/B test in smart campaign {campaignId}, client {clientId}.
Wipe every A/B branch out of campaign {campaignId}.
GET /{clientId}/smartcampaigns/{campaignId}/analysis Get recipient analysis results of a smart campaign · Get analysis data of a Smart Campaign #
Ask an LLM
“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?”
Tell an agent
Show the recipient analysis data for smart campaign {campaignId} in client {clientId}.
Check the analysis status and recipient count for campaign {campaignId}.
POST /{clientId}/smartcampaigns/{campaignId}/analysis Schedule a recipient analysis for a smart campaign · Schedule new recipient analysis for a Smart Campaign #
Ask an LLM
“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?”
Tell an agent
Schedule a new recipient analysis for smart campaign {campaignId} in client {clientId}.
Run a recipient analysis on campaign {campaignId}.
DELETE /{clientId}/smartcampaigns/{campaignId}/analysis Cancel a running recipient analysis · Cancel a running recipient analysis of a Smart Campaign #
Ask an LLM
“How do I stop a recipient analysis that is still running on a smart campaign?”
“Can an in-progress smart campaign analysis be cancelled?”
Tell an agent destructive · confirm first
Cancel the running recipient analysis of smart campaign {campaignId} in client {clientId}.
Abort the analysis currently in progress for campaign {campaignId}.
GET /{clientId}/smartcampaigns/{campaignId}/block Get a smart campaign's Block node · Get information about a "Block" node of a Smart Campaign #
Ask an LLM
“Which custom blacklists does the Block step of my smart campaign use?”
“What does the Block node in a smart campaign filter out?”
Tell an agent
Show the Block node of smart campaign {campaignId} in client {clientId}.
Get the blacklist IDs used by the Block step of campaign {campaignId}.
POST /{clientId}/smartcampaigns/{campaignId}/block Create or update a smart campaign's Block node · Create or update a "Block" node of a Smart Campaign #
Ask an LLM
“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?”
Tell an agent
Add a Block node using blacklists {customBlacklistIds} to smart campaign {campaignId} in client {clientId}.
Place the Block step of campaign {campaignId} after node {predecessorNodeId}.
DELETE /{clientId}/smartcampaigns/{campaignId}/block Delete a smart campaign's Block node · Delete a "Block" node of a Smart Campaign #
Ask an LLM
“How do I remove the blacklist Block step from a smart campaign?”
“Can I stop a smart campaign from blocking blacklisted recipients?”
Tell an agent destructive · confirm first
Delete the Block node from smart campaign {campaignId} in client {clientId}.
Drop the blacklist Block step from campaign {campaignId}.
GET /{clientId}/smartcampaigns/{campaignId}/cap Get a smart campaign's Limit node · Get information about a "Limit" node of a Smart Campaign #
Ask an LLM
“How many recipients is my smart campaign capped at?”
“What recipient limit does the Limit node of a smart campaign apply?”
Tell an agent
Show the Limit node of smart campaign {campaignId} in client {clientId}.
Get the recipient cap set on campaign {campaignId}.
POST /{clientId}/smartcampaigns/{campaignId}/cap Create or update a smart campaign's Limit node · Create or update a "Limit" node of a Smart Campaign #
Ask an LLM
“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?”
Tell an agent
Limit smart campaign {campaignId} in client {clientId} to {absolute} recipients.
Cap campaign {campaignId} at {relative} percent of recipients.
DELETE /{clientId}/smartcampaigns/{campaignId}/cap Delete a smart campaign's Limit node · Delete a "Limit" node of a Smart Campaign #
Ask an LLM
“How do I remove the recipient cap from a smart campaign?”
“Can I take the Limit step out of a smart campaign workflow?”
Tell an agent destructive · confirm first
Delete the Limit node from smart campaign {campaignId} in client {clientId}.
Remove the recipient cap on campaign {campaignId}.
GET /{clientId}/smartcampaigns/{campaignId}/messages List all mailings in a smart campaign · Get information about all mailings of a Smart Campaign #
Ask an LLM
“Which mailings belong to my smart campaign?”
“Can I see every email and push message inside one smart campaign?”
Tell an agent
List all mailings of smart campaign {campaignId} in client {clientId}.
Show every message defined in campaign {campaignId}.
POST /{clientId}/smartcampaigns/{campaignId}/messages Create a mailing in a smart campaign · Create a mailing #
Ask an LLM
“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?”
Tell an agent
Add a {mediaType} message called {name} to the workflow of smart campaign {campaignId}, client {clientId}.
Add a new mailing to campaign {campaignId} with subject {subject} from {senderAddress}.
GET /{clientId}/smartcampaigns/{campaignId}/messages/{mailingId} Get details of one smart campaign mailing · Get information about a mailing #
Ask an LLM
“What status and format is a particular campaign mailing in?”
“When was a specific smart campaign mailing created?”
Tell an agent
Get mailing {mailingId} of smart campaign {campaignId} in client {clientId}.
Show the status and type of mailing {mailingId}.
POST /{clientId}/smartcampaigns/{campaignId}/messages/{mailingId} Update a smart campaign mailing · Update a mailing #
Ask an LLM
“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?”
Tell an agent
Change the subject of mailing {mailingId} in smart campaign {campaignId}, client {clientId}, to {subject}.
Set the sender name of existing mailing {mailingId} to {senderName}.
DELETE /{clientId}/smartcampaigns/{campaignId}/messages/{mailingId} Delete a smart campaign mailing · Delete a mailing #
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Delete mailing {mailingId} from smart campaign {campaignId} in client {clientId}.
Remove the mailing {mailingId} from its campaign.
POST /{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/attachments Add attachments to a campaign email · Add attachments into a campaign message. #
Ask an LLM
“How do I attach files to an email in a smart campaign?”
“Can I add several attachments to a campaign mailing in one request?”
Tell an agent
Attach files {attachmentIds} to mailing {mailingId} in smart campaign {campaignId}, client {clientId}.
Add attachment {attachmentIds} to the email {mailingId}.
DELETE /{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/attachments Remove attachments from a campaign email · Delete attachments of a campaign message. #
Ask an LLM
“How do I take attachments off a smart campaign email?”
“Can I detach specific files from a campaign mailing?”
Tell an agent destructive · confirm first
Remove attachments {attachmentIds} from mailing {mailingId} in smart campaign {campaignId}, client {clientId}.
Detach file {attachmentIds} from email {mailingId}.
GET /{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/content Get the content of a campaign email · Get the content of a mailing (email) #
Ask an LLM
“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?”
Tell an agent
Get the content of mailing {mailingId} in smart campaign {campaignId}, client {clientId}.
Fetch the body of email {mailingId} as {Accept}.
POST /{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/content Upload new content for a campaign mailing · Update the content of a mailing #
Ask an LLM
“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?”
Tell an agent
Upload {content} as the body of mailing {mailingId} in smart campaign {campaignId}, client {clientId}.
Replace the content of mailing {mailingId} with new HTML.
DELETE /{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/content Clear the content of a campaign email · Delete the content of a mailing (email) #
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Delete the content of mailing {mailingId} in smart campaign {campaignId}, client {clientId}.
Clear out the email body of mailing {mailingId}.
GET /{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/test/{testMailingId} Get the sending status of a test mailing · Get information about the sending status of all recipients of a test mailing #
Ask an LLM
“Did my test mailing actually reach each test recipient?”
“Which recipients of a test send are still enqueued or failed?”
Tell an agent
Show the delivery status of test {testMailingId} for mailing {mailingId} in campaign {campaignId}, client {clientId}.
Report which recipients of test send {testMailingId} were sent or failed.
POST /{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/test Send a test of a campaign mailing · Send a test mailing #
Ask an LLM
“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?”
Tell an agent
Send a test of mailing {mailingId} in campaign {campaignId}, client {clientId}, to recipients {recipientIds} from list {recipientListId}.
Test-send mailing {mailingId} with subject {subject} to recipients {recipientIds} in list {recipientListId}.
POST /{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/tracking/links/{trackingLinkId} Update tracking on one link of a mailing · Update the tracking link configuration of a mailing #
Ask an LLM
“How do I turn off click tracking for a single link in a mailing?”
“Can I assign click profiles to a specific tracked link?”
Tell an agent
Set HTML tracking of link {trackingLinkId} in mailing {mailingId}, campaign {campaignId}, client {clientId} to {htmlTracking}.
Attach click profiles {clickProfileIds} to tracked link {trackingLinkId}.
GET /{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/tracking Get a mailing's open and click tracking settings · Get information about the tracking configuration of a mailing #
Ask an LLM
“Is open tracking switched on for my campaign mailing?”
“What are the overall tracking defaults of a mailing?”
Tell an agent
Show the tracking configuration of mailing {mailingId} in campaign {campaignId}, client {clientId}.
Check whether opens and clicks are tracked for mailing {mailingId}.
POST /{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/tracking Update a mailing's open and click tracking settings · Update the tracking configuration of a mailing #
Ask an LLM
“How do I enable open tracking for a whole mailing?”
“Can I stop tracking clicks across an entire campaign mailing?”
Tell an agent
Set open tracking for mailing {mailingId} in campaign {campaignId}, client {clientId} to {openTrackingEnabled}.
Turn click tracking for all of mailing {mailingId} to {clickTrackingEnabled}.
POST /{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/pause Pause one mailing in a smart campaign · Pause a mailing #
Ask an LLM
“How do I pause a single mailing without pausing the whole smart campaign?”
“Can I hold back one message in a smart campaign temporarily?”
Tell an agent
Pause mailing {mailingId} in smart campaign {campaignId}, client {clientId}.
Hold just the message {mailingId} for now.
POST /{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/start Start one mailing in a smart campaign · Start a mailing #
Ask an LLM
“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?”
Tell an agent
Start mailing {mailingId} in smart campaign {campaignId}, client {clientId}.
Begin sending the single message {mailingId}.
POST /{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/stop Stop one mailing in a smart campaign · Stop a mailing #
Ask an LLM
“How do I stop one mailing in a smart campaign for good?”
“Can a single campaign message be stopped while the rest keep running?”
Tell an agent destructive · confirm first
Stop mailing {mailingId} in smart campaign {campaignId}, client {clientId}.
Halt the message {mailingId} permanently.
GET /{clientId}/smartcampaigns/{campaignId}/recipientLists Get a smart campaign's Recipients node · Get information about a "Recipients" node #
Ask an LLM
“Which recipient lists feed the start of my smart campaign?”
“Where does the Recipients node sit in a smart campaign's grid?”
Tell an agent
Show the Recipients node of smart campaign {campaignId} in client {clientId}.
Get the recipient lists used as the audience of campaign {campaignId}.
POST /{clientId}/smartcampaigns/{campaignId}/recipientLists Set the recipient lists of a smart campaign · Create or update a "Recipients" node #
Ask an LLM
“How do I change which recipient lists a smart campaign sends to?”
“Can I point a smart campaign's Recipients node at several lists?”
Tell an agent
Set smart campaign {campaignId} in client {clientId} to use recipient lists {recipientListIds}.
Update the Recipients node of campaign {campaignId} to lists {recipientListIds}.
GET /{clientId}/smartcampaigns/{campaignId}/schedules List all Wait nodes of a smart campaign · Get information about all "Wait" nodes of a Smart Campaign #
Ask an LLM
“What waiting periods are built into my smart campaign?”
“Can I see all the delay steps of a smart campaign together?”
Tell an agent
List every Wait node in smart campaign {campaignId} for client {clientId}.
Show all delay steps configured in campaign {campaignId}.
POST /{clientId}/smartcampaigns/{campaignId}/schedules Add a Wait node to a smart campaign · Create a new "Wait" node in a Smart Campaign #
Ask an LLM
“How do I add a delay step to a smart campaign?”
“Can a smart campaign wait until after a recipient import before continuing?”
Tell an agent
Add a Wait node scheduled at {scheduledAt} to smart campaign {campaignId} in client {clientId}.
Insert a new delay step after node {predecessorNodeId} in campaign {campaignId}.
GET /{clientId}/smartcampaigns/{campaignId}/schedules/{waitNodeId} Get one Wait node of a smart campaign · Get information about a "Wait" node of a Smart Campaign #
Ask an LLM
“How long does a particular Wait step in my smart campaign pause for?”
“What is the fallback time of one specific delay node?”
Tell an agent
Show Wait node {waitNodeId} of smart campaign {campaignId} in client {clientId}.
Get the delay period of wait step {waitNodeId}.
POST /{clientId}/smartcampaigns/{campaignId}/schedules/{waitNodeId} Update a Wait node in a smart campaign · Update a "Wait" node in a Smart Campaign #
Ask an LLM
“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?”
Tell an agent
Reschedule Wait node {waitNodeId} in smart campaign {campaignId}, client {clientId}, to {scheduledAt}.
Set send time optimization on existing wait step {waitNodeId} to {enabled}.
DELETE /{clientId}/smartcampaigns/{campaignId}/schedules/{waitNodeId} Delete a Wait node from a smart campaign · Delete a "Wait" node in a Smart Campaign #
Ask an LLM
“How do I remove a delay step from a smart campaign?”
“Can I delete one specific Wait node?”
Tell an agent destructive · confirm first
Delete Wait node {waitNodeId} from smart campaign {campaignId} in client {clientId}.
Remove the wait step {waitNodeId}.
GET /{clientId}/smartcampaigns/{campaignId}/targetGroups List all Target groups nodes of a smart campaign · Get information about all "Target groups" nodes of a Smart Campaign #
Ask an LLM
“Which target groups split the audience of my smart campaign?”
“Can I see all the audience segmentation steps in a smart campaign?”
Tell an agent
List every Target groups node in smart campaign {campaignId} for client {clientId}.
Show all target group filters used in campaign {campaignId}.
POST /{clientId}/smartcampaigns/{campaignId}/targetGroups Create or update a Target groups node · Create or update a "Target groups" node of a Smart Campaign #
Ask an LLM
“How do I segment a smart campaign's recipients by target group?”
“Can I insert a target group filter between two campaign steps?”
Tell an agent
Add a Target groups node named {name} to smart campaign {campaignId} in client {clientId}.
Filter campaign {campaignId} by target group definition {targetGroup}.
DELETE /{clientId}/smartcampaigns/{campaignId}/targetGroups Delete all Target groups nodes of a smart campaign · Delete all "Target groups" nodes of a Smart Campaign #
Ask an LLM
“How do I clear every target group filter from a smart campaign at once?”
“Can I remove all audience segmentation nodes in one call?”
Tell an agent destructive · confirm first
Delete all Target groups nodes from smart campaign {campaignId} in client {clientId}.
Wipe every target group filter out of campaign {campaignId}.
GET /{clientId}/smartcampaigns/{campaignId}/targetGroups/{filterNodeId} Get one Target groups node of a smart campaign · Get information about a "Target groups" node of a Smart Campaign #
Ask an LLM
“What target group does one specific filter node in my campaign use?”
“Which node follows a particular target group step?”
Tell an agent
Show Target groups node {filterNodeId} of smart campaign {campaignId} in client {clientId}.
Get the target group behind filter node {filterNodeId}.
DELETE /{clientId}/smartcampaigns/{campaignId}/targetGroups/{filterNodeId} Delete one Target groups node · Delete a "Target groups" node of a Smart Campaign #
Ask an LLM
“How do I remove only one target group filter from a smart campaign?”
“Can I delete a single segmentation node by its ID?”
Tell an agent destructive · confirm first
Delete Target groups node {filterNodeId} from smart campaign {campaignId} in client {clientId}.
Remove the single target group filter {filterNodeId}.
GET /{clientId}/smartcampaigns/{campaignId}/throttles List all Throttle nodes of a smart campaign · Get information about all "Throttle" nodes of a Smart Campaign #
Ask an LLM
“What sending-rate limits are set across my smart campaign?”
“Can I see all the Throttle steps in one smart campaign?”
Tell an agent
List every Throttle node in smart campaign {campaignId} for client {clientId}.
Show all messages-per-hour limits in campaign {campaignId}.
POST /{clientId}/smartcampaigns/{campaignId}/throttles Add a Throttle node to a smart campaign · Create a new "Throttle" node in a Smart Campaign #
Ask an LLM
“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?”
Tell an agent
Add a Throttle node of {maxMessagesPerHour} messages per hour to smart campaign {campaignId} in client {clientId}.
Insert a new throttle after node {predecessorNodeId} in campaign {campaignId}.
GET /{clientId}/smartcampaigns/{campaignId}/throttles/{throttleNodeId} Get one Throttle node of a smart campaign · Get information about a "Throttle" node of a Smart Campaign #
Ask an LLM
“What hourly sending limit does a particular Throttle step apply?”
“Which node comes after one specific throttle in my campaign?”
Tell an agent
Show Throttle node {throttleNodeId} of smart campaign {campaignId} in client {clientId}.
Get the messages-per-hour cap of throttle {throttleNodeId}.
POST /{clientId}/smartcampaigns/{campaignId}/throttles/{throttleNodeId} Update a Throttle node in a smart campaign · Update a "Throttle" node of a Smart Campaign #
Ask an LLM
“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?”
Tell an agent
Change Throttle node {throttleNodeId} in smart campaign {campaignId}, client {clientId}, to {maxMessagesPerHour} per hour.
Reconnect existing throttle {throttleNodeId} to successor node {successorNodeId}.
DELETE /{clientId}/smartcampaigns/{campaignId}/throttles/{throttleNodeId} Delete a Throttle node from a smart campaign · Delete a "Throttle" node in a Smart Campaign #
Ask an LLM
“How do I remove a sending-rate limit step from a smart campaign?”
“Can I delete one specific Throttle node?”
Tell an agent destructive · confirm first
Delete Throttle node {throttleNodeId} from smart campaign {campaignId} in client {clientId}.
Remove the throttle {throttleNodeId}.
GET /{clientId}/smartcampaigns/{campaignId}/report Get a smart campaign performance report · Get a campaign report #
Ask an LLM
“How many opens, clicks and bounces did my smart campaign get?”
“What were the unsubscribes from a smart campaign?”
Tell an agent
Get the performance report for smart campaign {campaignId} in client {clientId}.
Show opens, clicks and bounces for campaign {campaignId}.
POST /{clientId}/smartcampaigns/{campaignId}/stop Cancel a smart campaign · Cancel a Smart Campaign #
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Cancel smart campaign {campaignId} in client {clientId}.
Stop the whole smart campaign {campaignId} permanently.

Documentation

📖
Documentation
https://docs.developers.optimizely.com/web-experimentation/docs/rest-api-introduction
📖
Documentation
https://docs.developers.optimizely.com/feature-experimentation/reference/feature-experimentation-api-overview
📖
Documentation
https://docs.developers.optimizely.com/optimizely-campaign/docs/rest-api
📖
Documentation
https://docs.developers.optimizely.com/content-management-system/v1.5.0-content-delivery-api/docs/content-delivery-api
📖
Documentation
https://docs.developers.optimizely.com/content-management-system/v1.6.0-content-management-api/docs/getting-started
📖
Documentation
https://docs.developers.optimizely.com/platform-optimizely/docs/getting-started-with-graphql-api
📖
Documentation
https://docs.developers.optimizely.com/optimizely-data-platform/reference/introduction
📖
Documentation
https://docs.developers.optimizely.com/content-marketing-platform/docs/open-api-introduction
📖
Documentation
https://docs.developers.optimizely.com/commerce-connect/v1.3.0-service-api-developer-guide/docs/optimizely-service-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-smart-campaigns-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/asyncapi/optimizely-feature-experimentation-asyncapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/asyncapi/optimizely-cmp-asyncapi.yml

Other Resources

🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/graphql/optimizely-graphql.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/optimizely:optimizely-smart-campaigns-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optimizely-smart-campaigns-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Optimizely Smart Campaigns API
  version: '1.0'
  description: 'Operations tagged Smart Campaigns across 2 of this provider''s published API definitions: optimizely-campaign-openapi.yml, optimizely-campaign-optimizely-campaign-rest-api-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.campaign.episerver.net/rest
  description: Optimizely Campaign Production Server
tags:


# --- truncated at 32 KB (122 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-smart-campaigns-api-openapi.yml