Jump to Content

Dev Guide API Reference User Guide

Dev Guide API Reference

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

Assets
Attachments
Personalized Attachments
- Create a personalized attachmentpost
Blocklist entries
Confirmations
Smart Campaigns
Transactional mails
Click profiles
Coupon blocks
Custom blocklists
Scheduled jobs
- Get information about all configured scheduled jobsget
- Get information about all running scheduled jobsget
Folders
Mail archive
Mail ID
Message templates
Opt-in processes
Recipient lists
Recipients
Responses
Batch sending
Unsubscribes
Users
- Get basic information of an authenticated user.get
- Rotate a password. Please be aware that after rotation it can take some minutes until the new password can be used.post
Webhooks

Get the total number of images

get https://api.campaign.episerver.net/rest/{clientId}/assets/images/count

Language

Credentials

Header

Select from the Examples drop-down list.

Optimizely Campaign REST API
Assets
Delete an imagedelete
Update the image namepost
Get information about an imageget
Upload an imagepost
Get information about all imagesget
Get the total number of imagesget
Attachments
Delete an attachmentdelete
Update attachment informationpost
Get information about an attachmentget
Update the content of an uploaded attachmentpost
Get the content of an uploaded attachmentget
Create an attachmentpost
Get information about all attachmentsget
Get the total number of attachmentsget
Personalized Attachments
Create a personalized attachmentpost
Blocklist entries
Delete a blocklist entrydelete
Get information about a blocklist entryget
Delete multiple blocklist entriesdelete
Create a blocklist entrypost
Get information about all blocklist entriesget
Get the total number of blocklist entriesget
Check whether an address is blocklistedget
Confirmations
Stop a confirmation mailingpost
Start a confirmation mailingpost
Get a campaign reportget
Send a test mailingpost
Get information about the sending status of all recipients of a test mailingget
Create or update a "Recipients" nodepost
Get information about a "Recipients" nodeget
Update the tracking configuration of a mailingpost
Get information about the tracking configuration of a mailingget
Get information about all tracking links of a mailingget
Update the tracking link configuration of a mailingpost
Get information about a tracking link of a mailingget
Get information about the sending status of all recipients of a test mailingget
Get the content of a mailing (email)get
Delete attachments of a campaign message. Only applicable for campaign message of type emaildelete
Add attachments into a campaign message. Only applicable for campaign message of type emailpost
Update a mailingpost
Delete a confirmation mailingdelete
Get information about a confirmation mailingget
Create a confirmation mailpost
Get information about all confirmation mailingsget
Smart Campaigns
Cancel a Smart Campaignpost
Start a Smart Campaignpost
Get a campaign reportget
Pause a Smart Campaignpost
Delete a "Throttle" node in a Smart Campaigndelete
Update a "Throttle" node of a Smart Campaignpost
Get information about a "Throttle" node of a Smart Campaignget
Create a new "Throttle" node in a Smart Campaignpost
Get information about all "Throttle" nodes of a Smart Campaignget
Delete a "Target groups" node of a Smart Campaigndelete
Get information about a "Target groups" node of a Smart Campaignget
Delete all "Target groups" nodes of a Smart Campaigndelete
Create or update a "Target groups" node of a Smart Campaignpost
Get information about all "Target groups" nodes of a Smart Campaignget
Delete a "Wait" node in a Smart Campaigndelete
Update a "Wait" node in a Smart Campaignpost
Get information about a "Wait" node of a Smart Campaignget
Create a new "Wait" node in a Smart Campaignpost
Get information about all "Wait" nodes of a Smart Campaignget
Create or update a "Recipients" nodepost
Get information about a "Recipients" nodeget
Stop a mailingpost
Start a mailingpost
Pause a mailingpost
Update the tracking configuration of a mailingpost
Get information about the tracking configuration of a mailingget
Get information about all tracking links of a mailingget
Update the tracking link configuration of a mailingpost
Get information about a tracking link of a mailingget
Send a test mailingpost
Get information about the sending status of all recipients of a test mailingget
Delete the content of a mailing (email)delete
Update the content of a mailingpost
Get the content of a mailing (email)get
Delete attachments of a campaign message. Only applicable for campaign message of type emaildelete
Add attachments into a campaign message. Only applicable for campaign message of type emailpost
Delete a mailingdelete
Update a mailingpost
Get information about a mailingget
Create a mailingpost
Get information about all mailings of a Smart Campaignget
Delete a "Limit" node of a Smart Campaigndelete
Create or update a "Limit" node of a Smart Campaignpost
Get information about a "Limit" node of a Smart Campaignget
Delete a "Block" node of a Smart Campaigndelete
Create or update a "Block" node of a Smart Campaignpost
Get information about a "Block" node of a Smart Campaignget
Cancel a running recipient analysis of a Smart Campaigndelete
Schedule new recipient analysis for a Smart Campaignpost
Get analysis data of a Smart Campaignget
Delete all connections from the "A/B test" node to other nodesdelete
Get information about all connections from an "A/B test" nodeget
Delete a connection from a "A/B test" node to another nodedelete
Create or update a connection from a "A/B test" nodepost
Get information about a connection from an "A/B test" nodeget
Delete an "A/B test" node of a Smart Campaigndelete
Create or update an "A/B test" node of a Smart Campaignpost
Get information about a "A/B test" node of a Smart Campaignget
Delete a Smart Campaigndelete
Update the name of a Smart Campaignpost
Get information about a Smart Campaignget
Deactivate a Smart Campaignpost
Activate a Smart Campaignpost
Create or copy a Smart Campaignpost
Get information about all Smart Campaignsget
Transactional mails
Get the sending status of a sent transactional mailget
Stop a transactional mailpost
Start a transactional mailpost
Get a campaign reportget
Send a transactional mailpost
Send a test mailingpost
Get information about the sending status of all recipients of a test mailingget
Create or update a "Recipients" nodepost
Get information about a "Recipients" nodeget
Update the tracking configuration of a mailingpost
Get information about the tracking configuration of a mailingget
Get information about all tracking links of a mailingget
Update the tracking link configuration of a mailingpost
Get information about a tracking link of a mailingget
Get information about the sending status of all recipients of a test mailingget
Update the content of a mailingpost
Get the content of a mailing (email)get
Delete attachments of a campaign message. Only applicable for campaign message of type emaildelete
Add attachments into a campaign message. Only applicable for campaign message of type emailpost
Update a mailingpost
Delete a transactional maildelete
Get information about a transactional mailget
Create a transactional mailpost
Get information about all transactional mailsget
Click profiles
Update a click profilepost
Get information about a click profileget
Unassign specific links from a click profiledelete
Assign links to a click profilepost
Get links a click profile is assigned toget
Create a new click profilepost
Get information about all click profilesget
Coupon blocks
Get all mailing IDs a coupon block is assigned toget
Delete a coupon codedelete
Invalidate a coupon codepost
Get information about a coupon codeget
Delete coupon codesdelete
Create a list of coupon codespost
Get information about coupon codesget
Delete a coupon blockdelete
Get information about a coupon blockget
Create a new coupon blockpost
Get information about all coupon blocksget
Custom blocklists
Update a custom blocklistpost
Get information about a custom blocklistget
Delete a custom blocklist entrydelete
Update a custom blocklist entrypost
Get information about a custom blocklist entryget
Delete all entries from a custom blocklistdelete
Create custom blocklist entriespost
Get information about all entries of a custom blocklistget
Create a custom blocklistpost
Get information about all custom blocklistsget
Scheduled jobs
Get information about all running scheduled jobsget
Get information about all configured scheduled jobsget
Folders
Unassign from an entitypost
Delete a folderdelete
Update a folderpost
Get information about a folderget
Assign to an entitypost
Create a folderpost
Get information about all foldersget
Mail archive
Get compressed file with archived mailing contentsget
Get the content of an archived mailingget
Get information about all archived mailingsget
Get information about an archived mailingget
Mail ID
Retrieve a mail IDget
Get information about a plain mail ID (contains only mailing id)get
Get information about a mail IDget
Message templates
Test a message templatepost
Delete a message templatedelete
Update a message templatepost
Get information about a message templateget
Create or copy a message templatepost
Get information about all message templatesget
Opt-in processes
Update an opt-in processpost
Get information about an opt-in processget
Create an opt-in processpost
Get information about all opt-in processesget
Recipient lists
Get the fields of a recipient listget
Get the attribute names of a recipient listget
Update a recipient listpost
Get information about a recipient listget
Copy a recipient listpost
Get information about all recipient listsget
Recipients
Update a recipient IDpost
Delete the recipient historydelete
Check whether a recipient is valid in multiple recipient listsget
Delete a tracking opt-outdelete
Create a tracking opt-outpost
Check whether a recipient is validget
Check status optin of given recipientget
Delete a recipient from a recipient listdelete
Update attribute values of a recipientpost
Get information about a recipientget
Update attribute values of recipients filtered by a target grouppost
Update attribute values of multiple recipientsput
Get all distinct attribute values of a recipientget
Get the total number of recipients for distinct attribute valuesget
Get the total number of recipients in a recipient listget
Delete recipients from a recipient listdelete
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
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
Get information about all recipients in a recipient listget
Responses
Get information about all responses of a recipientget
Get the maximum number of allowed bounces of a recipientget
Get information about whether a recipient has exceeded the hard or the soft bounce thresholdget
Delete hard and soft bouncesdelete
Get the total number of hard or soft bounces of a recipientget
Batch sending
Prepares new sending batchpost
Get information about all sending batchesget
Send campaign to the chunked recipientspost
Persist chunked recipientsput
Get information about a sending batchget
Unsubscribes
Remove one or multiple recipients from the internal unsubscribe listdelete
Add recipients to the internal unsubscribe list or unsubscribe recipients (max. 5000)post
Get information about all unsubscribe entriesget
Get the total number of unsubscribesget
Users
Rotate a password. Please be aware that after rotation it can take some minutes until the new password can be used.post
Get basic information of an authenticated user.get
Webhooks
Verify a webhookget
Delete a webhookdelete
Update a webhookput
Deactivate a webhookpost
Create a webhookpost
Get information about all webhooksget
Activate a webhookpost

System Status
Privacy Notice
Website Terms of Use
Cookie Settings
Trust Center
Third-Party Addons & Platforms