Optimizely Campaign REST API
Email and omnichannel campaign management, formerly Episerver Campaign and optivo broadmail — mailings, smart campaigns and their nodes, recipient lists, transactional mail, unsubscribes and webhooks. 137 paths served under the versioned vendor media type application/vnd.optivo.broadmail.v1+json. Harvested verbatim 2026-08-13.
Optimizely Campaign REST API is one of 50 APIs that Optimizely publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Email and Marketing Automation. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 234 operations across 137 paths, organized into 23 resource areas, and defines 150 schemas. It is described by OpenAPI 3.0.1, at version 1.
Requests are made against a single base URL, https://api.campaign.episerver.net/rest.
234 operations
137 paths
150 schemas
37 DELETE105 GET88 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Optimizely Campaign REST API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (Authorization).
Paths & Operations 234
Across 137 paths, the API surfaces 234 operations — 37 DELETE, 105 GET, 88 POST, 4 PUT. They span 23 resource areas, including Assets, Attachments, Personalized Attachments, Blocklist entries, Confirmations, Smart Campaigns, Transactional mails, Click profiles, and 15 more. Each is listed below with its method, path, parameters, and response codes.
Assets 6
Manage assets
GET
/{clientId}/assets/images/count
Get the total number of images
GET
/{clientId}/assets/images
Get information about all images
POST
/{clientId}/assets/images
Upload an image
GET
/{clientId}/assets/images/{imageId}
Get information about an image
POST
/{clientId}/assets/images/{imageId}
Update the image name
DELETE
/{clientId}/assets/images/{imageId}
Delete an image
Attachments 8
Manage email attachments
GET
/{clientId}/attachments/count
Get the total number of attachments
GET
/{clientId}/attachments
Get information about all attachments
POST
/{clientId}/attachments
Create an attachment
GET
/{clientId}/attachments/{attachmentId}/content
Get the content of an uploaded attachment
POST
/{clientId}/attachments/{attachmentId}/content
Update the content of an uploaded attachment
GET
/{clientId}/attachments/{attachmentId}
Get information about an attachment
POST
/{clientId}/attachments/{attachmentId}
Update attachment information
DELETE
/{clientId}/attachments/{attachmentId}
Delete an attachment
Personalized Attachments 1
Manage personalized email attachments
POST
/{clientId}/attachments/personalized
Create a personalized attachment
Blocklist entries 7
Manage recipients on the blocklist
GET
/{clientId}/blacklistentries/blacklisted
Check whether an address is blocklisted
GET
/{clientId}/blacklistentries/count
Get the total number of blocklist entries
GET
/{clientId}/blacklistentries
Get information about all blocklist entries
POST
/{clientId}/blacklistentries
Create a blocklist entry
DELETE
/{clientId}/blacklistentries
Delete multiple blocklist entries
GET
/{clientId}/blacklistentries/{entry}
Get information about a blocklist entry
DELETE
/{clientId}/blacklistentries/{entry}
Delete a blocklist entry
Confirmations 21
Manage registration confirmations (opt-in emails)
GET
/{clientId}/confirmations
Get information about all confirmation mailings
POST
/{clientId}/confirmations
Create a confirmation mail
GET
/{clientId}/confirmations/{confirmationMailId}
Get information about a confirmation mailing
DELETE
/{clientId}/confirmations/{confirmationMailId}
Delete a confirmation mailing
POST
/{clientId}/confirmations/{confirmationMailId}/message
Update a mailing
POST
/{clientId}/confirmations/{confirmationMailId}/message/attachments
Add attachments into a campaign message. Only applicable for campaign message of type email
DELETE
/{clientId}/confirmations/{confirmationMailId}/message/attachments
Delete attachments of a campaign message. Only applicable for campaign message of type email
GET
/{clientId}/confirmations/{confirmationMailId}/message/content
Get the content of a mailing (email)
GET
/{clientId}/confirmations/{confirmationMailId}/message/test/{testMailingId}
Get information about the sending status of all recipients of a test mailing
GET
/{clientId}/confirmations/{confirmationMailId}/message/tracking/links/{trackingLinkId}
Get information about a tracking link of a mailing
POST
/{clientId}/confirmations/{confirmationMailId}/message/tracking/links/{trackingLinkId}
Update the tracking link configuration of a mailing
GET
/{clientId}/confirmations/{confirmationMailId}/message/tracking/links
Get information about all tracking links of a mailing
GET
/{clientId}/confirmations/{confirmationMailId}/message/tracking
Get information about the tracking configuration of a mailing
POST
/{clientId}/confirmations/{confirmationMailId}/message/tracking
Update the tracking configuration of a mailing
GET
/{clientId}/confirmations/{confirmationMailId}/recipientLists
Get information about a "Recipients" node
POST
/{clientId}/confirmations/{confirmationMailId}/recipientLists
Create or update a "Recipients" node
GET
/{clientId}/confirmations/{confirmationMailId}/test/{testMailingId}
Get information about the sending status of all recipients of a test mailing
POST
/{clientId}/confirmations/{confirmationMailId}/test
Send a test mailing
GET
/{clientId}/confirmations/{confirmationMailId}/report
Get a campaign report
POST
/{clientId}/confirmations/{confirmationMailId}/start
Start a confirmation mailing
POST
/{clientId}/confirmations/{confirmationMailId}/stop
Stop a confirmation mailing
Smart Campaigns 65
Manage Smart Campaigns
GET
/{clientId}/smartcampaigns
Get information about all Smart Campaigns
POST
/{clientId}/smartcampaigns
Create or copy a Smart Campaign
POST
/{clientId}/smartcampaigns/{campaignId}/activate
Activate a Smart Campaign
POST
/{clientId}/smartcampaigns/{campaignId}/deactivate
Deactivate a Smart Campaign
GET
/{clientId}/smartcampaigns/{campaignId}
Get information about a Smart Campaign
POST
/{clientId}/smartcampaigns/{campaignId}
Update the name of a Smart Campaign
DELETE
/{clientId}/smartcampaigns/{campaignId}
Delete a Smart Campaign
GET
/{clientId}/smartcampaigns/{campaignId}/abtest
Get information about a "A/B test" node of a Smart Campaign
POST
/{clientId}/smartcampaigns/{campaignId}/abtest
Create or update an "A/B test" node of a Smart Campaign
DELETE
/{clientId}/smartcampaigns/{campaignId}/abtest
Delete an "A/B test" node of a Smart Campaign
GET
/{clientId}/smartcampaigns/{campaignId}/abtest/successors/{nodeId}
Get information about a connection from an "A/B test" node
POST
/{clientId}/smartcampaigns/{campaignId}/abtest/successors/{nodeId}
Create or update a connection from a "A/B test" node
DELETE
/{clientId}/smartcampaigns/{campaignId}/abtest/successors/{nodeId}
Delete a connection from a "A/B test" node to another node
GET
/{clientId}/smartcampaigns/{campaignId}/abtest/successors
Get information about all connections from an "A/B test" node
DELETE
/{clientId}/smartcampaigns/{campaignId}/abtest/successors
Delete all connections from the "A/B test" node to other nodes
GET
/{clientId}/smartcampaigns/{campaignId}/analysis
Get analysis data of a Smart Campaign
POST
/{clientId}/smartcampaigns/{campaignId}/analysis
Schedule new recipient analysis for a Smart Campaign
DELETE
/{clientId}/smartcampaigns/{campaignId}/analysis
Cancel a running recipient analysis of a Smart Campaign
GET
/{clientId}/smartcampaigns/{campaignId}/block
Get information about a "Block" node of a Smart Campaign
POST
/{clientId}/smartcampaigns/{campaignId}/block
Create or update a "Block" node of a Smart Campaign
DELETE
/{clientId}/smartcampaigns/{campaignId}/block
Delete a "Block" node of a Smart Campaign
GET
/{clientId}/smartcampaigns/{campaignId}/cap
Get information about a "Limit" node of a Smart Campaign
POST
/{clientId}/smartcampaigns/{campaignId}/cap
Create or update a "Limit" node of a Smart Campaign
DELETE
/{clientId}/smartcampaigns/{campaignId}/cap
Delete a "Limit" node of a Smart Campaign
GET
/{clientId}/smartcampaigns/{campaignId}/messages
Get information about all mailings of a Smart Campaign
POST
/{clientId}/smartcampaigns/{campaignId}/messages
Create a mailing
GET
/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}
Get information about a mailing
POST
/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}
Update a mailing
DELETE
/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}
Delete a mailing
POST
/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/attachments
Add attachments into a campaign message. Only applicable for campaign message of type email
DELETE
/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/attachments
Delete attachments of a campaign message. Only applicable for campaign message of type email
GET
/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/content
Get the content of a mailing (email)
POST
/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/content
Update the content of a mailing
DELETE
/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/content
Delete the content of a mailing (email)
GET
/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/test/{testMailingId}
Get information about the sending status of all recipients of a test mailing
POST
/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/test
Send a test mailing
GET
/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/tracking/links/{trackingLinkId}
Get information about a tracking link of a mailing
POST
/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/tracking/links/{trackingLinkId}
Update the tracking link configuration of a mailing
GET
/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/tracking/links
Get information about all tracking links of a mailing
GET
/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/tracking
Get information about the tracking configuration of a mailing
POST
/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/tracking
Update the tracking configuration of a mailing
POST
/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/pause
Pause a mailing
POST
/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/start
Start a mailing
POST
/{clientId}/smartcampaigns/{campaignId}/messages/{mailingId}/stop
Stop a mailing
GET
/{clientId}/smartcampaigns/{campaignId}/recipientLists
Get information about a "Recipients" node
POST
/{clientId}/smartcampaigns/{campaignId}/recipientLists
Create or update a "Recipients" node
GET
/{clientId}/smartcampaigns/{campaignId}/schedules
Get information about all "Wait" nodes of a Smart Campaign
POST
/{clientId}/smartcampaigns/{campaignId}/schedules
Create a new "Wait" node in a Smart Campaign
GET
/{clientId}/smartcampaigns/{campaignId}/schedules/{waitNodeId}
Get information about a "Wait" node of a Smart Campaign
POST
/{clientId}/smartcampaigns/{campaignId}/schedules/{waitNodeId}
Update a "Wait" node in a Smart Campaign
DELETE
/{clientId}/smartcampaigns/{campaignId}/schedules/{waitNodeId}
Delete a "Wait" node in a Smart Campaign
GET
/{clientId}/smartcampaigns/{campaignId}/targetGroups
Get information about all "Target groups" nodes of a Smart Campaign
POST
/{clientId}/smartcampaigns/{campaignId}/targetGroups
Create or update a "Target groups" node of a Smart Campaign
DELETE
/{clientId}/smartcampaigns/{campaignId}/targetGroups
Delete all "Target groups" nodes of a Smart Campaign
GET
/{clientId}/smartcampaigns/{campaignId}/targetGroups/{filterNodeId}
Get information about a "Target groups" node of a Smart Campaign
DELETE
/{clientId}/smartcampaigns/{campaignId}/targetGroups/{filterNodeId}
Delete a "Target groups" node of a Smart Campaign
GET
/{clientId}/smartcampaigns/{campaignId}/throttles
Get information about all "Throttle" nodes of a Smart Campaign
POST
/{clientId}/smartcampaigns/{campaignId}/throttles
Create a new "Throttle" node in a Smart Campaign
GET
/{clientId}/smartcampaigns/{campaignId}/throttles/{throttleNodeId}
Get information about a "Throttle" node of a Smart Campaign
POST
/{clientId}/smartcampaigns/{campaignId}/throttles/{throttleNodeId}
Update a "Throttle" node of a Smart Campaign
DELETE
/{clientId}/smartcampaigns/{campaignId}/throttles/{throttleNodeId}
Delete a "Throttle" node in a Smart Campaign
POST
/{clientId}/smartcampaigns/{campaignId}/pause
Pause a Smart Campaign
GET
/{clientId}/smartcampaigns/{campaignId}/report
Get a campaign report
POST
/{clientId}/smartcampaigns/{campaignId}/start
Start a Smart Campaign
POST
/{clientId}/smartcampaigns/{campaignId}/stop
Cancel a Smart Campaign
Transactional mails 24
Manage transactional mails that are triggered by a recipient action or event
GET
/{clientId}/transactionalmail
Get information about all transactional mails
POST
/{clientId}/transactionalmail
Create a transactional mail
GET
/{clientId}/transactionalmail/{transactionalMailId}
Get information about a transactional mail
DELETE
/{clientId}/transactionalmail/{transactionalMailId}
Delete a transactional mail
POST
/{clientId}/transactionalmail/{transactionalMailId}/message
Update a mailing
POST
/{clientId}/transactionalmail/{transactionalMailId}/message/attachments
Add attachments into a campaign message. Only applicable for campaign message of type email
DELETE
/{clientId}/transactionalmail/{transactionalMailId}/message/attachments
Delete attachments of a campaign message. Only applicable for campaign message of type email
GET
/{clientId}/transactionalmail/{transactionalMailId}/message/content
Get the content of a mailing (email)
POST
/{clientId}/transactionalmail/{transactionalMailId}/message/content
Update the content of a mailing
GET
/{clientId}/transactionalmail/{transactionalMailId}/message/test/{testMailingId}
Get information about the sending status of all recipients of a test mailing
GET
/{clientId}/transactionalmail/{transactionalMailId}/message/tracking/links/{trackingLinkId}
Get information about a tracking link of a mailing
POST
/{clientId}/transactionalmail/{transactionalMailId}/message/tracking/links/{trackingLinkId}
Update the tracking link configuration of a mailing
GET
/{clientId}/transactionalmail/{transactionalMailId}/message/tracking/links
Get information about all tracking links of a mailing
GET
/{clientId}/transactionalmail/{transactionalMailId}/message/tracking
Get information about the tracking configuration of a mailing
POST
/{clientId}/transactionalmail/{transactionalMailId}/message/tracking
Update the tracking configuration of a mailing
GET
/{clientId}/transactionalmail/{transactionalMailId}/recipientLists
Get information about a "Recipients" node
POST
/{clientId}/transactionalmail/{transactionalMailId}/recipientLists
Create or update a "Recipients" node
GET
/{clientId}/transactionalmail/{transactionalMailId}/test/{testMailingId}
Get information about the sending status of all recipients of a test mailing
POST
/{clientId}/transactionalmail/{transactionalMailId}/test
Send a test mailing
POST
/{clientId}/transactionalmail/{transactionalMailId}/send
Send a transactional mail
GET
/{clientId}/transactionalmail/{transactionalMailId}/report
Get a campaign report
POST
/{clientId}/transactionalmail/{transactionalMailId}/start
Start a transactional mail
POST
/{clientId}/transactionalmail/{transactionalMailId}/stop
Stop a transactional mail
GET
/{clientId}/transactionalmail/status
Get the sending status of a sent transactional mail
Click profiles 7
Manage click profiles
GET
/{clientId}/clickprofiles
Get information about all click profiles
POST
/{clientId}/clickprofiles
Create a new click profile
GET
/{clientId}/clickprofiles/{clickProfileId}/assignedlinks
Get links a click profile is assigned to
POST
/{clientId}/clickprofiles/{clickProfileId}/assignedlinks
Assign links to a click profile
DELETE
/{clientId}/clickprofiles/{clickProfileId}/assignedlinks
Unassign specific links from a click profile
GET
/{clientId}/clickprofiles/{clickProfileId}
Get information about a click profile
POST
/{clientId}/clickprofiles/{clickProfileId}
Update a click profile
Coupon blocks 11
Manage coupon blocks that organize coupon codes
GET
/{clientId}/couponblocks
Get information about all coupon blocks
POST
/{clientId}/couponblocks
Create a new coupon block
GET
/{clientId}/couponblocks/{couponBlockId}
Get information about a coupon block
DELETE
/{clientId}/couponblocks/{couponBlockId}
Delete a coupon block
GET
/{clientId}/couponblocks/{couponBlockId}/codes
Get information about coupon codes
POST
/{clientId}/couponblocks/{couponBlockId}/codes
Create a list of coupon codes
DELETE
/{clientId}/couponblocks/{couponBlockId}/codes
Delete coupon codes
GET
/{clientId}/couponblocks/{couponBlockId}/codes/{code}
Get information about a coupon code
POST
/{clientId}/couponblocks/{couponBlockId}/codes/{code}
Invalidate a coupon code
DELETE
/{clientId}/couponblocks/{couponBlockId}/codes/{code}
Delete a coupon code
GET
/{clientId}/couponblocks/{couponBlockId}/assignedmailings
Get all mailing IDs a coupon block is assigned to
Custom blocklists 10
Manage custom blocklists
GET
/{clientId}/customblacklists
Get information about all custom blocklists
POST
/{clientId}/customblacklists
Create a custom blocklist
GET
/{clientId}/customblacklists/{customBlacklistId}/entries
Get information about all entries of a custom blocklist
POST
/{clientId}/customblacklists/{customBlacklistId}/entries
Create custom blocklist entries
DELETE
/{clientId}/customblacklists/{customBlacklistId}/entries
Delete all entries from a custom blocklist
GET
/{clientId}/customblacklists/{customBlacklistId}/entries/{customBlacklistEntryId}
Get information about a custom blocklist entry
POST
/{clientId}/customblacklists/{customBlacklistId}/entries/{customBlacklistEntryId}
Update a custom blocklist entry
DELETE
/{clientId}/customblacklists/{customBlacklistId}/entries/{customBlacklistEntryId}
Delete a custom blocklist entry
GET
/{clientId}/customblacklists/{customBlacklistId}
Get information about a custom blocklist
POST
/{clientId}/customblacklists/{customBlacklistId}
Update a custom blocklist
Scheduled jobs 2
Get information about scheduled jobs
GET
/{clientId}/customerjobs/configured
Get information about all configured scheduled jobs
GET
/{clientId}/customerjobs/running
Get information about all running scheduled jobs
Folders 7
Manage folders for mailings, message templates, custom blacklists, images, recipient list and attachment
GET
/{clientId}/folders
Get information about all folders
POST
/{clientId}/folders
Create a folder
POST
/{clientId}/folders/{folderId}/assign
Assign to an entity
GET
/{clientId}/folders/{folderId}
Get information about a folder
POST
/{clientId}/folders/{folderId}
Update a folder
DELETE
/{clientId}/folders/{folderId}
Delete a folder
POST
/{clientId}/folders/{folderId}/unassign
Unassign from an entity
Mail archive 4
Get archived mailings
GET
/{clientId}/mailarchive/{bmMailId}
Get information about an archived mailing
GET
/{clientId}/mailarchive
Get information about all archived mailings
GET
/{clientId}/mailarchive/{bmMailId}/content
Get the content of an archived mailing
GET
/{clientId}/mailarchive/content
Get compressed file with archived mailing contents
Mail ID 3
Get information about a mail ID
GET
/{clientId}/mailid/{mailId}
Get information about a mail ID
GET
/{clientId}/mailid/{mailId}/plain
Get information about a plain mail ID (contains only mailing id)
GET
/{clientId}/mailid
Retrieve a mail ID
Message templates 6
Manage message templates
GET
/{clientId}/messagetemplates
Get information about all message templates
POST
/{clientId}/messagetemplates
Create or copy a message template
GET
/{clientId}/messagetemplates/{messageTemplateId}
Get information about a message template
POST
/{clientId}/messagetemplates/{messageTemplateId}
Update a message template
DELETE
/{clientId}/messagetemplates/{messageTemplateId}
Delete a message template
POST
/{clientId}/messagetemplates/{messageTemplateId}/test
Test a message template
Opt-in processes 4
View, update and create opt-in processes
GET
/{clientId}/optinprocesses
Get information about all opt-in processes
POST
/{clientId}/optinprocesses
Create an opt-in process
GET
/{clientId}/optinprocesses/{optinProcessId}
Get information about an opt-in process
POST
/{clientId}/optinprocesses/{optinProcessId}
Update an opt-in process
Recipient lists 6
View, copy and update recipient lists
GET
/{clientId}/recipientlists
Get information about all recipient lists
POST
/{clientId}/recipientlists
Copy a recipient list
GET
/{clientId}/recipientlists/{recipientListId}
Get information about a recipient list
POST
/{clientId}/recipientlists/{recipientListId}
Update a recipient list
GET
/{clientId}/recipientlists/{recipientListId}/attributeNames
Get the attribute names of a recipient list
GET
/{clientId}/recipientlists/{recipientListId}/fields
Get the fields of a recipient list
Recipients 19
Manage recipients or delete recipient history
GET
/{clientId}/recipients/{recipientListId}
Get information about all recipients in a recipient list
PUT
/{clientId}/recipients/{recipientListId}
Add multiple recipients to a recipient list. Double opt-in processes will not be overwritten by other opt-in processes (see Opt-in documentation ).
POST
/{clientId}/recipients/{recipientListId}
Add a recipient to a recipient list. Double opt-in processes will not be overwritten by other opt-in processes (see Opt-in documentation ).
DELETE
/{clientId}/recipients/{recipientListId}
Delete recipients from a recipient list
GET
/{clientId}/recipients/{recipientListId}/count
Get the total number of recipients in a recipient list
GET
/{clientId}/recipients/{recipientListId}/distinctvalues/count
Get the total number of recipients for distinct attribute values
GET
/{clientId}/recipients/{recipientListId}/distinctvalues
Get all distinct attribute values of a recipient
PUT
/{clientId}/recipients/{recipientListId}/modify
Update attribute values of multiple recipients
POST
/{clientId}/recipients/{recipientListId}/modify
Update attribute values of recipients filtered by a target group
GET
/{clientId}/recipients/{recipientListId}/{recipientId}
Get information about a recipient
POST
/{clientId}/recipients/{recipientListId}/{recipientId}
Update attribute values of a recipient
DELETE
/{clientId}/recipients/{recipientListId}/{recipientId}
Delete a recipient from a recipient list
GET
/{clientId}/recipients/{recipientListId}/{recipientId}/optinstatus
Check status optin of given recipient
GET
/{clientId}/recipients/{recipientListId}/{recipientId}/valid
Check whether a recipient is valid
POST
/{clientId}/recipients/trackingoptout
Create a tracking opt-out
DELETE
/{clientId}/recipients/trackingoptout
Delete a tracking opt-out
GET
/{clientId}/recipients
Check whether a recipient is valid in multiple recipient lists
DELETE
/{clientId}/recipients
Delete the recipient history
POST
/{clientId}/recipients/updaterecipientid
Update a recipient ID
Responses 5
Manage mailing responses, such as hard or soft bounces
GET
/{clientId}/responses/bounces/{recipientId}
Get the total number of hard or soft bounces of a recipient
DELETE
/{clientId}/responses/bounces/{recipientId}
Delete hard and soft bounces
GET
/{clientId}/responses/bounces/{recipientId}/thresholdExceeded
Get information about whether a recipient has exceeded the hard or the soft bounce threshold
GET
/{clientId}/responses/bounces
Get the maximum number of allowed bounces of a recipient
GET
/{clientId}/responses
Get information about all responses of a recipient
Batch sending 5
Create and send messages as batches to recipients segmented in separate platform
GET
/{clientId}/sending/batches/{sendingBatchId}
Get information about a sending batch
PUT
/{clientId}/sending/batches/{sendingBatchId}
Persist chunked recipients
POST
/{clientId}/sending/batches/{sendingBatchId}
Send campaign to the chunked recipients
GET
/{clientId}/sending/batches
Get information about all sending batches
POST
/{clientId}/sending/batches
Prepares new sending batch
Unsubscribes 4
Manage recipients on an unsubscribe list
GET
/{clientId}/unsubscribes/count
Get the total number of unsubscribes
GET
/{clientId}/unsubscribes
Get information about all unsubscribe entries
POST
/{clientId}/unsubscribes
Add recipients to the internal unsubscribe list or unsubscribe recipients (max. 5000)
DELETE
/{clientId}/unsubscribes
Remove one or multiple recipients from the internal unsubscribe list
Users 2
User Management
GET
/{clientId}/users/authenticated
Get basic information of an authenticated user.
POST
/{clientId}/users/rotatepassword
Rotate a password. Please be aware that after rotation it can take some minutes until the new password can be used.
Webhooks 7
Manage webhooks
POST
/{clientId}/webhooks/{webhookId}/activate
Activate a webhook
GET
/{clientId}/webhooks
Get information about all webhooks
POST
/{clientId}/webhooks
Create a webhook
POST
/{clientId}/webhooks/{webhookId}/deactivate
Deactivate a webhook
PUT
/{clientId}/webhooks/{webhookId}
Update a webhook
DELETE
/{clientId}/webhooks/{webhookId}
Delete a webhook
GET
/{clientId}/webhooks/{webhookId}/verify
Verify a webhook
Schemas 150
The contract defines 150 schemas that model the data the API accepts and returns. The most detailed are RestMessageNode (34 properties), MessageRequestData (27 properties), EventBasedMailingRequestData (24 properties), ConfirmationMailingRequestData (21 properties). Each schema is shown below with its type and property counts.
RestCount
object
2 properties
RestMultiPartRequestSchema
object
2 properties
1 required
RestImage
object
7 properties
RestApiLink
object
2 properties
RestImageStreamingCollection
object
5 properties
RestAttachment
object
11 properties
AttachmentRequestData
object
3 properties
RestPersonalizedAttachment
object
List of uploaded attachments
6 properties
RestPersonalizedAttachmentUpload
object
2 properties
BodyPart
object
8 properties
ContentDisposition
object
7 properties
FormDataBodyPart
object
Attachment files
12 properties
FormDataContentDisposition
object
8 properties
MessageBodyWorkers
object
MultiPart
object
9 properties
ParameterizedHeader
object
2 properties
RestAttachmentStreamingCollection
object
5 properties
RestBlacklistedEntry
object
2 properties
BlacklistEntryRequestData
object
2 properties
1 required
RestBlacklistEntry
object
6 properties
RestBlacklistEntryStreamingCollection
object
5 properties
ConfirmationMailingRequestData
object
21 properties
4 required
Filter
object
1 property
Point
object
Grid location point
2 properties
RestMessageNode
object
34 properties
RestRecipientListsNode
object
5 properties
RestSmartCampaign
object
15 properties
RestTargetGroupNode
object
6 properties
MultiRequest
object
1 property
TestMailingReport
object
7 properties
TestMailingStartedReport
object
5 properties
TestMailingRequestData
object
5 properties
2 required
RestTrackingLink
object
9 properties
TrackingLinkConfigurationRequestData
object
4 properties
RestTrackingConfiguration
object
6 properties
TrackingConfigurationRequestData
object
5 properties
MessageRequestData
object
27 properties
RecipientListsRequestData
object
2 properties
1 required
CampaignMailingRestReport
object
8 properties
RestBounces
object
Number of hard and soft bounces
2 properties
RestClicks
object
Number of unique and total clicks
2 properties
RestOpens
object
Number of unique and total opens
2 properties
RestRecipients
object
Number of total, skipped and in-queue recipients
4 properties
RestReport
object
5 properties
RestSmartCampaignStreamingCollection
object
5 properties
CampaignRequestData
object
3 properties
SplitRequestData
object
12 properties
RestDelay
object
Delay time
3 properties
RestPersonalizedSchedule
object
Send time optimization settings
5 properties
RestSplitNode
object
5 properties
RestSplitOptimization
object
6 properties
RestSplitSuccessor
object
6 properties
SplitSuccessorRequestData
object
6 properties
RestAnalysisData
object
4 properties
BlockRequestData
object
3 properties
RestBlockNode
object
5 properties
CapRequestData
object
4 properties
RestCapNode
object
6 properties
WaitRequestData
object
10 properties
RestWaitNode
object
8 properties
TargetGroupRequestData
object
4 properties
ThrottleRequestData
object
3 properties
RestThrottleNode
object
5 properties
EventBasedMailingRequestData
object
24 properties
4 required
SendTransactionalMailingRequestData
object
4 properties
2 required
RestMailId
object
1 property
RestSendStatus
object
2 properties
ClickProfileRequestData
object
4 properties
1 required
RestClickProfile
object
8 properties
AssignLinksToClickProfileRequestData
object
1 property
1 required
RestLink
object
6 properties
RestLinkStreamingCollection
object
5 properties
RestClickProfileStreamingCollection
object
5 properties
CouponBlockRequestData
object
3 properties
2 required
RestCouponBlock
object
8 properties
RestCouponBlockCounter
object
Counter of coupon codes
3 properties
CouponCodeRequestData
object
1 property
1 required
RestCouponCode
object
8 properties
RestCouponCodeStreamingCollection
object
5 properties
RestAssignedMailings
object
1 property
RestCouponBlockStreamingCollection
object
5 properties
CustomBlacklistRequestData
object
2 properties
1 required
RestCustomBlacklist
object
6 properties
CreateCustomBlacklistEntriesRequestData
object
2 properties
1 required
RestCustomBlacklistEntry
object
6 properties
CustomBlacklistEntryRequestData
object
1 property
RestCustomBlacklistEntryStreamingCollection
object
5 properties
RestCustomBlacklistStreamingCollection
object
5 properties
RestConfiguredJob
object
5 properties
RestConfiguredJobStreamingCollection
object
5 properties
RestJobTrigger
object
6 properties
RestRunningJob
object
3 properties
RestRunningJobStreamingCollection
object
5 properties
FolderRequestData
object
3 properties
2 required
RestFolder
object
6 properties
UnAssignEntityToFolderRequestData
object
1 property
1 required
RestFolderStreamingCollection
object
5 properties
RestArchiveMail
object
5 properties
RestMailIdInfo
object
4 properties
RestMailIdPlainInfo
object
2 properties
RestMailIdPlain
object
1 property
MessageTemplateRequestData
object
13 properties
1 required
RestMessageTemplate
object
17 properties
MessageTemplateTestMailingRequestData
object
5 properties
2 required
MessageTemplateTestResponse
object
1 property
RestMessageTemplateStreamingCollection
object
5 properties
OptinProcessRequestData
object
5 properties
2 required
RestOptinProcess
object
9 properties
RestOptinProcessStreamingCollection
object
5 properties
CopyRecipientListRequestData
object
1 property
1 required
RestRecipientList
object
10 properties
RestRecipientListAttributeNames
object
2 properties
RestRecipientListField
object
4 properties
RestRecipientListFieldStreamingCollection
object
5 properties
RecipientListRequestData
object
3 properties
RestRecipientListStreamingCollection
object
5 properties
CreateRecipientRequestData
object
5 properties
1 required
RestRecipient
object
5 properties
CreateRecipientsRequestData
object
2 properties
ExtendedRecipient
object
3 properties
RestRecipientsCreationModify
object
2 properties
RestAttributeValuesWithCount
object
1 property
RestAttributeValues
object
2 properties
Recipient
object
2 properties
UpdateRecipientsRequestData
object
2 properties
ModifyRecipientsAttributesRequestData
object
3 properties
1 required
RestRecipientValid
object
4 properties
ModifyRecipientAttributesRequestData
object
2 properties
RestRecipientStreamingCollection
object
5 properties
RecipientBasedRequestData
object
1 property
1 required
UpdateRecipientIdRequestData
object
2 properties
2 required
RestBounceCounterThresholdExceeded
object
2 properties
RestResponse
object
9 properties
RestResponseStreamingCollection
object
5 properties
RestChunk
object
2 properties
RecipientsChunkRequestData
object
2 properties
RestSendingBatch
object
7 properties
PrepareSendingBatchRequest
object
3 properties
2 required
RestSendingBatchStreamingCollection
object
5 properties
CreateUnsubscribesRequestData
object
4 properties
RestUnsubscribesCreateResult
object
2 properties
RestUnsubscribe
object
7 properties
RestUnsubscribeStreamingCollection
object
5 properties
AuthenticatedUser
object
3 properties
UserRequestData
object
2 properties
2 required
RestUser
object
2 properties
RestWebhook
object
8 properties
WebhookAuthentication
object
Authentication method and attributes
1 property
1 required
WebhookRequestData
object
6 properties
3 required
RestWebhookVerify
object
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Optimizely 12
Other APIs Optimizely publishes across the network.
Optimizely Experimentation REST API v2
Optimizely Feature Experimentation Flags API v1
Optimizely Flags Scheduling API
Optimizely Permission Service API
Optimizely Agent API
Optimizely Event API
Optimizely Edge Decider API
Optimizely Data Platform (ODP) API v3
Optimizely Graph API
Optimizely Content Marketing Platform (CMP) API v3
Optimizely Configured Commerce API
Optimizely CMS Content Delivery API v3.0
#Email#Marketing Automation
Where this information came from
This is an independent, third-party profile of Optimizely Campaign REST API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.