For AI agents: visit https://docs.developers.optimizely.com/optimizely-campaign/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Dev Guide
API Reference
User Guide
Dev Guide
API Reference
Commerce Connect
Configured Commerce
Content Management System
Content Marketing Platform
Cross-platform products
Digital Experience Platform
Experimentation Data
Feature Experimentation
Optimizely Connect Platform
Optimizely Data Platform
Performance Edge
Recommendations
Web Experimentation
Campaign
Deprecated Products
Dev Guide
API Reference
User Guide
NuGet
Dev Community
Optimizely Academy
Submit a ticket
Log In
API Reference
NuGet
Dev Community
Optimizely Academy
Submit a ticket
Log In
Campaign
API Reference
Get the total number of images
Optimizely Campaign REST API
Assets
Get the total number of images
get
Get information about all images
get
Upload an image
post
Get information about an image
get
Update the image name
post
Delete an image
del
Attachments
Get the total number of attachments
get
Get information about all attachments
get
Create an attachment
post
Get the content of an uploaded attachment
get
Update the content of an uploaded attachment
post
Get information about an attachment
get
Update attachment information
post
Delete an attachment
del
Personalized Attachments
Create a personalized attachment
post
Blocklist entries
Check whether an address is blocklisted
get
Get the total number of blocklist entries
get
Get information about all blocklist entries
get
Create a blocklist entry
post
Delete multiple blocklist entries
del
Get information about a blocklist entry
get
Delete a blocklist entry
del
Confirmations
Get information about all confirmation mailings
get
Create a confirmation mail
post
Get information about a confirmation mailing
get
Delete a confirmation mailing
del
Update a mailing
post
Add attachments into a campaign message. Only applicable for campaign message of type email
post
Delete attachments of a campaign message. Only applicable for campaign message of type email
del
Get the content of a mailing (email)
get
Get information about the sending status of all recipients of a test mailing
get
Get information about a tracking link of a mailing
get
Update the tracking link configuration of a mailing
post
Get information about all tracking links of a mailing
get
Get information about the tracking configuration of a mailing
get
Update the tracking configuration of a mailing
post
Get information about a "Recipients" node
get
Create or update a "Recipients" node
post
Get information about the sending status of all recipients of a test mailing
get
Send a test mailing
post
Get a campaign report
get
Start a confirmation mailing
post
Stop a confirmation mailing
post
Smart Campaigns
Get information about all Smart Campaigns
get
Create or copy a Smart Campaign
post
Activate a Smart Campaign
post
Deactivate a Smart Campaign
post
Get information about a Smart Campaign
get
Update the name of a Smart Campaign
post
Delete a Smart Campaign
del
Get information about a "A/B test" node of a Smart Campaign
get
Create or update an "A/B test" node of a Smart Campaign
post
Delete an "A/B test" node of a Smart Campaign
del
Get information about a connection from an "A/B test" node
get
Create or update a connection from a "A/B test" node
post
Delete a connection from a "A/B test" node to another node
del
Get information about all connections from an "A/B test" node
get
Delete all connections from the "A/B test" node to other nodes
del
Get analysis data of a Smart Campaign
get
Schedule new recipient analysis for a Smart Campaign
post
Cancel a running recipient analysis of a Smart Campaign
del
Get information about a "Block" node of a Smart Campaign
get
Create or update a "Block" node of a Smart Campaign
post
Delete a "Block" node of a Smart Campaign
del
Get information about a "Limit" node of a Smart Campaign
get
Create or update a "Limit" node of a Smart Campaign
post
Delete a "Limit" node of a Smart Campaign
del
Get information about all mailings of a Smart Campaign
get
Create a mailing
post
Get information about a mailing
get
Update a mailing
post
Delete a mailing
del
Add attachments into a campaign message. Only applicable for campaign message of type email
post
Delete attachments of a campaign message. Only applicable for campaign message of type email
del
Get the content of a mailing (email)
get
Update the content of a mailing
post
Delete the content of a mailing (email)
del
Get information about the sending status of all recipients of a test mailing
get
Send a test mailing
post
Get information about a tracking link of a mailing
get
Update the tracking link configuration of a mailing
post
Get information about all tracking links of a mailing
get
Get information about the tracking configuration of a mailing
get
Update the tracking configuration of a mailing
post
Pause a mailing
post
Start a mailing
post
Stop a mailing
post
Get information about a "Recipients" node
get
Create or update a "Recipients" node
post
Get information about all "Wait" nodes of a Smart Campaign
get
Create a new "Wait" node in a Smart Campaign
post
Get information about a "Wait" node of a Smart Campaign
get
Update a "Wait" node in a Smart Campaign
post
Delete a "Wait" node in a Smart Campaign
del
Get information about all "Target groups" nodes of a Smart Campaign
get
Create or update a "Target groups" node of a Smart Campaign
post
Delete all "Target groups" nodes of a Smart Campaign
del
Get information about a "Target groups" node of a Smart Campaign
get
Delete a "Target groups" node of a Smart Campaign
del
Get information about all "Throttle" nodes of a Smart Campaign
get
Create a new "Throttle" node in a Smart Campaign
post
Get information about a "Throttle" node of a Smart Campaign
get
Update a "Throttle" node of a Smart Campaign
post
Delete a "Throttle" node in a Smart Campaign
del
Pause a Smart Campaign
post
Get a campaign report
get
Start a Smart Campaign
post
Cancel a Smart Campaign
post
Transactional mails
Get information about all transactional mails
get
Create a transactional mail
post
Get information about a transactional mail
get
Delete a transactional mail
del
Update a mailing
post
Add attachments into a campaign message. Only applicable for campaign message of type email
post
Delete attachments of a campaign message. Only applicable for campaign message of type email
del
Get the content of a mailing (email)
get
Update the content of a mailing
post
Get information about the sending status of all recipients of a test mailing
get
Get information about a tracking link of a mailing
get
Update the tracking link configuration of a mailing
post
Get information about all tracking links of a mailing
get
Get information about the tracking configuration of a mailing
get
Update the tracking configuration of a mailing
post
Get information about a "Recipients" node
get
Create or update a "Recipients" node
post
Get information about the sending status of all recipients of a test mailing
get
Send a test mailing
post
Send a transactional mail
post
Get a campaign report
get
Start a transactional mail
post
Stop a transactional mail
post
Get the sending status of a sent transactional mail
get
Click profiles
Get information about all click profiles
get
Create a new click profile
post
Get links a click profile is assigned to
get
Assign links to a click profile
post
Unassign specific links from a click profile
del
Get information about a click profile
get
Update a click profile
post
Coupon blocks
Get information about all coupon blocks
get
Create a new coupon block
post
Get information about a coupon block
get
Delete a coupon block
del
Get information about coupon codes
get
Create a list of coupon codes
post
Delete coupon codes
del
Get information about a coupon code
get
Invalidate a coupon code
post
Delete a coupon code
del
Get all mailing IDs a coupon block is assigned to
get
Custom blocklists
Get information about all custom blocklists
get
Create a custom blocklist
post
Get information about all entries of a custom blocklist
get
Create custom blocklist entries
post
Delete all entries from a custom blocklist
del
Get information about a custom blocklist entry
get
Update a custom blocklist entry
post
Delete a custom blocklist entry
del
Get information about a custom blocklist
get
Update a custom blocklist
post
Scheduled jobs
Get information about all configured scheduled jobs
get
Get information about all running scheduled jobs
get
Folders
Get information about all folders
get
Create a folder
post
Assign to an entity
post
Get information about a folder
get
Update a folder
post
Delete a folder
del
Unassign from an entity
post
Mail archive
Get information about an archived mailing
get
Get information about all archived mailings
get
Get the content of an archived mailing
get
Get compressed file with archived mailing contents
get
Mail ID
Get information about a mail ID
get
Get information about a plain mail ID (contains only mailing id)
get
Retrieve a mail ID
get
Message templates
Get information about all message templates
get
Create or copy a message template
post
Get information about a message template
get
Update a message template
post
Delete a message template
del
Test a message template
post
Opt-in processes
Get information about all opt-in processes
get
Create an opt-in process
post
Get information about an opt-in process
get
Update an opt-in process
post
Recipient lists
Get information about all recipient lists
get
Copy a recipient list
post
Get information about a recipient list
get
Update a recipient list
post
Get the attribute names of a recipient list
get
Get the fields of a recipient list
get
Recipients
Get information about all recipients in a recipient list
get
Add multiple recipients to a recipient list. Double opt-in processes will not be overwritten by other opt-in processes (see <a href="https://support.optimizely.com/hc/en-us/articles/4413192291981#prioritization">Opt-in documentation</a>).
put
Add a recipient to a recipient list. Double opt-in processes will not be overwritten by other opt-in processes (see <a href="https://support.optimizely.com/hc/en-us/articles/4413192291981#prioritization">Opt-in documentation</a>).
post
Delete recipients from a recipient list
del
Get the total number of recipients in a recipient list
get
Get the total number of recipients for distinct attribute values
get
Get all distinct attribute values of a recipient
get
Update attribute values of multiple recipients
put
