Optimizely Campaign REST API

{"openapi":"3.0.1","info":{"title":"Optimizely Campaign REST API","description":"This documentation lists all available resources and endpoints of the Optimizely Campaign REST API. The REST API lets you integrate Optimizely Campaign with your business applications and third-party software. Use Optimizely Campaign features and functionalities remotely to manage your recipient data, campaigns and mailings.<br><br>To use the REST API, set up your Optimizely Campaign client first. See <a href=\"https://docs.developers.optimizely.com/optimizely-campaign/docs/getting-started#client-setup\" target=\"_blank\">Client setup</a> on Optimizely World.<br><br>The base URL for all API requests is as follows: <i>https://api.campaign.episerver.net/rest/{clientId}/{component}/{path}?{parameters}</i><br><br><b>Try it out</b><br>The \"Try it out\" feature lets you test the API before you implement it in the target system. To perform real API requests against your client, authorize with your Base64-encoded credentials. See <a href=\"https://docs.developers.optimizely.com/optimizely-campaign/docs/getting-started#authenticate\" target=\"_blank\">Authentication</a> on Optimizely World.<br><br>To learn more about the Optimizely Campaign REST API, see <a href=\"https://docs.developers.optimizely.com/optimizely-campaign/docs/rest-api\" target=\"_blank\">Optimizely World</a>.<br><br><br>If you want to import the API definition in Postman, download the <a href=\"https://api.campaign.episerver.net/rest/openapi.json\" target=\"_blank\" download> source file</a> and import it in Postman as a collection.","version":"1"},"servers":[{"url":"https://api.campaign.episerver.net/rest"}],"tags":[{"name":"Assets","description":"Manage assets"},{"name":"Attachments","description":"Manage email attachments"},{"name":"Personalized Attachments","description":"Manage personalized email attachments"},{"name":"Blocklist entries","description":"Manage recipients on the blocklist"},{"name":"Confirmations","description":"Manage registration confirmations (opt-in emails)"},{"name":"Smart Campaigns","description":"Manage Smart Campaigns"},{"name":"Transactional mails","description":"Manage transactional mails that are triggered by a recipient action or event"},{"name":"Click profiles","description":"Manage click profiles"},{"name":"Coupon blocks","description":"Manage coupon blocks that organize coupon codes"},{"name":"Custom blocklists","description":"Manage custom blocklists"},{"name":"Scheduled jobs","description":"Get information about scheduled jobs"},{"name":"Folders","description":"Manage folders for mailings, message templates, custom blacklists, images, recipient list and attachment"},{"name":"Mail archive","description":"Get archived mailings"},{"name":"Mail ID","description":"Get information about a mail ID"},{"name":"Message templates","description":"Manage message templates"},{"name":"Opt-in processes","description":"View, update and create opt-in processes"},{"name":"Recipient lists","description":"View, copy and update recipient lists"},{"name":"Recipients","description":"Manage recipients or delete recipient history"},{"name":"Responses","description":"Manage mailing responses, such as hard or soft bounces"},{"name":"Batch sending","description":"Create and send messages as batches to recipients segmented in separate platform"},{"name":"Unsubscribes","description":"Manage recipients on an unsubscribe list"},{"name":"Users","description":"User Management"},{"name":"Webhooks","description":"Manage webhooks"}],"paths":{"/{clientId}/assets/images/count":{"get":{"tags":["Assets"],"summary":"Get the total number of images","operationId":"count","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The total number was retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestCount"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestCount"}}}}},"security":[{"Authorization":[]}]}},"/{clientId}/assets/images":{"get":{"tags":["Assets"],"summary":"Get information about all images","description":"Get detailed information about all images, such as ID, name, URL, height and width in pixels. You can limit the number of retrieved images and set the starting point of the result list.","operationId":"getAllImages","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Starting point of the result list <p><i>Default value</i> : 0</p>","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum number of retrieved images<p><i>Default value</i> : 100</p>","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"The images were retrieved successfully (empty result if none were found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestImageStreamingCollection"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestImageStreamingCollection"}}}},"400":{"description":"Invalid limit request. Change the limit to less than 10000."}},"security":[{"Authorization":[]}]},"post":{"tags":["Assets"],"summary":"Upload an image","description":"Upload an image either by specifying a file or URL.","operationId":"createImage","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RestMultiPartRequestSchema"}}}},"responses":{"201":{"description":"The image was uploaded successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestImage"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestImage"}}}},"400":{"description":"The parameters \"name\" or \"url\" are both provided or not provided, or the file name is missing. Alternatively, the image content type is not one of [image/jpeg, image/png, image/gif]"},"500":{"description":"Error occurred while uploading the image."}},"security":[{"Authorization":[]}]}},"/{clientId}/assets/images/{imageId}":{"get":{"tags":["Assets"],"summary":"Get information about an image","description":"Get detailed information about an image, such as name, URL, height and width in pixels.","operationId":"getImage","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}},{"name":"imageId","in":"path","description":"Image ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"The image was retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestImage"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestImage"}}}},"404":{"description":"The image could not be found. Ensure that the required parameters such as \"imageId\" are correct and the image exists."}},"security":[{"Authorization":[]}]},"post":{"tags":["Assets"],"summary":"Update the image name","operationId":"updateImage","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}},{"name":"imageId","in":"path","description":"Image ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"New image name"}}}}}},"responses":{"200":{"description":"New name of image was updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestImage"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestImage"}}}},"400":{"description":"The parameter \"name\" is missing."},"404":{"description":"The image could not be found. Ensure that the required parameters such as \"imageId\" are correct and the image exists."}},"security":[{"Authorization":[]}]},"delete":{"tags":["Assets"],"summary":"Delete an image","operationId":"deleteImage","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}},{"name":"imageId","in":"path","description":"Image ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"The image was deleted successfully."},"404":{"description":"The image could not be found. Ensure that the required parameters such as \"imageId\" are correct and the image exists."},"500":{"description":"Error occurred while deleting uploaded images."}},"security":[{"Authorization":[]}]}},"/{clientId}/attachments/count":{"get":{"tags":["Attachments"],"summary":"Get the total number of attachments","operationId":"count_1","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The total number was retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestCount"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestCount"}}}}},"security":[{"Authorization":[]}]}},"/{clientId}/attachments":{"get":{"tags":["Attachments"],"summary":"Get information about all attachments","description":"Get detailed information about all attachments, such as type, mime type, size or creation date. You can sort the result by specific criteria and limit the maximum number of retrieved attachments.","operationId":"getAllAttachments","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Starting point of the result list <p><i>Default value</i> : 0</p>","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum number of retrieved attachments<p><i>Default value</i> : 100</p>","schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"Sort result by specific criteria","schema":{"type":"string","default":"created","enum":["id","mailingGroup","name","uploaded","url","fileName","type","mimeType","size","created","modified"]}},{"name":"direction","in":"query","description":"Sort order","schema":{"type":"string","default":"ASC","enum":["ASC","DESC"]}}],"responses":{"200":{"description":"The attachments were retrieved successfully (empty result if none were found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestAttachmentStreamingCollection"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestAttachmentStreamingCollection"}}}},"400":{"description":"Invalid limit request. Change the limit to less than 10000."}},"security":[{"Authorization":[]}]},"post":{"tags":["Attachments"],"summary":"Create an attachment","description":"Create an attachment. You can specify name, mime type or attachment file.","operationId":"createAttachment","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RestMultiPartRequestSchema"}}}},"responses":{"201":{"description":"The attachment was created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestAttachment"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestAttachment"}}}},"400":{"description":"The parameters \"name\" and \"file\" are required or the file name has an invalid extension. Ensure that \"name\" and \"file\" parameters are added to the request and the file extension is correct."}},"security":[{"Authorization":[]}]}},"/{clientId}/attachments/{attachmentId}/content":{"get":{"tags":["Attachments"],"summary":"Get the content of an uploaded attachment","operationId":"getUploadAttachment","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"Attachment ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"The uploaded content attachment was downloaded successfully.","content":{"application/octet-stream":{"schema":{"type":"object"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"type":"object"}}}},"404":{"description":"The attachment could not be found. Ensure that the required parameters such as \"attachmentId\" are correct and the attachment exists."}},"security":[{"Authorization":[]}]},"post":{"tags":["Attachments"],"summary":"Update the content of an uploaded attachment","operationId":"uploadAttachment","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"Attachment ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RestMultiPartRequestSchema"}}}},"responses":{"200":{"description":"The attachment content was updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestAttachment"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestAttachment"}}}},"404":{"description":"The attachment could not be found. Ensure that the required parameters such as \"attachmentId\" are correct and the attachment exists."}},"security":[{"Authorization":[]}]}},"/{clientId}/attachments/{attachmentId}":{"get":{"tags":["Attachments"],"summary":"Get information about an attachment","description":"Get detailed information about an attachment, such as type, mime type, size or creation date.","operationId":"getAttachment","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"Attachment ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"The attachment was retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestAttachment"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestAttachment"}}}}},"security":[{"Authorization":[]}]},"post":{"tags":["Attachments"],"summary":"Update attachment information","description":"Update attachment information. You can specify name, file name or mime type.","operationId":"updateAttachment","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"Attachment ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/AttachmentRequestData"}}}},"responses":{"200":{"description":"The attachment was updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestAttachment"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestAttachment"}}}},"404":{"description":"The attachment could not be found. Ensure that the required parameters such as \"attachmentId\" are correct and the attachment exists."}},"security":[{"Authorization":[]}]},"delete":{"tags":["Attachments"],"summary":"Delete an attachment","operationId":"deleteAttachment","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}},{"name":"attachmentId","in":"path","description":"Attachment ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"The attachment was deleted successfully."},"404":{"description":"The attachment could not be found. Ensure that the required parameters such as \"attachmentId\" are correct and the attachment exists."},"409":{"description":"The attachment is being used by at least one mailing and can not be deleted"}},"security":[{"Authorization":[]}]}},"/{clientId}/attachments/personalized":{"post":{"tags":["Personalized Attachments","Attachments"],"summary":"Create a personalized attachment","description":"Create a personalized attachment. You can specify the attachment name and attachment file(s).","operationId":"createAttachment_1","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RestMultiPartRequestSchema"}}}},"responses":{"200":{"description":"The attachment was created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestPersonalizedAttachmentUpload"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestPersonalizedAttachmentUpload"}}}},"400":{"description":"An erroneous request was sent."},"406":{"description":"The uploaded file is empty."},"500":{"description":"The request could not be processed successfully."}},"security":[{"Authorization":[]}]}},"/{clientId}/blacklistentries/blacklisted":{"get":{"tags":["Blocklist entries"],"summary":"Check whether an address is blocklisted","operationId":"blacklisted","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}},{"name":"address","in":"query","description":"Address to be checked","schema":{"type":"string"}}],"responses":{"200":{"description":"true/false as result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestBlacklistedEntry"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestBlacklistedEntry"}}}}},"security":[{"Authorization":[]}]}},"/{clientId}/blacklistentries/count":{"get":{"tags":["Blocklist entries"],"summary":"Get the total number of blocklist entries","description":"Get the total number of blocklist entries. You can choose whether to include or exclude parent clients.","operationId":"count_2","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}},{"name":"includeParent","in":"query","description":"Include parent clients in the counting<p><i>Default value</i> : false</p>","schema":{"type":"boolean"}}],"responses":{"200":{"description":"The number of blocklist entries was retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestCount"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestCount"}}}}},"security":[{"Authorization":[]}]}},"/{clientId}/blacklistentries":{"get":{"tags":["Blocklist entries"],"summary":"Get information about all blocklist entries","description":"Get detailed information about all blocklist entries, such as pattern, reason or creation date. You can limit the maximum number of retrieved blocklist entries and sort the result by specific criteria.","operationId":"findAllBlacklistEntries","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Starting point of the result list <p><i>Default value</i> : 0</p>","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum number of retrieved blocklist entries<p><i>Default value</i> : 100</p>","schema":{"type":"integer","format":"int32"}},{"name":"pattern","in":"query","description":"Matching pattern","schema":{"type":"array","items":{"type":"string"}}},{"name":"reason","in":"query","description":"Matching reason","schema":{"type":"string"}},{"name":"sort","in":"query","schema":{"type":"string","description":"Sort result by specific criteria","default":"created","enum":["pattern","reason","created","modified"]}},{"name":"direction","in":"query","description":"Sort order","schema":{"type":"string","enum":["ASC","DESC"]}}],"responses":{"200":{"description":"The blocklist entries were retrieved successfully (empty result if none was found).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestBlacklistEntryStreamingCollection"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestBlacklistEntryStreamingCollection"}}}},"400":{"description":"Invalid limit request. Change the limit to less than 10000."}},"security":[{"Authorization":[]}]},"post":{"tags":["Blocklist entries"],"summary":"Create a blocklist entry","description":"Create a blocklist entry. You can specify a reason for blocklisting.","operationId":"createBlacklistEntry","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/BlacklistEntryRequestData"}}}},"responses":{"201":{"description":"The blocklist entry was created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestBlacklistEntry"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestBlacklistEntry"}}}},"400":{"description":"A required value for the entry is not provided. Check for the blocklist entry pattern and add it to the request."}},"security":[{"Authorization":[]}]},"delete":{"tags":["Blocklist entries"],"summary":"Delete multiple blocklist entries","operationId":"deleteBlacklistEntries","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}},{"name":"entries","in":"query","description":"List of blocklist entry patterns<p><b>Note:</b> If the blocklist entry pattern contains special characters, the pattern must be URL-encoded. For example, use the code %2f for a forward slash (/), %252f for a double slash (//), %2B for a plus sign (+) etc.</p>","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"The deletion was initiated successfully."},"400":{"description":"The list of entries is not provided or the number of entries has exceeded the limit. Provide an array with blocklist entries or limit the number of entries to a maximum of 1000."}},"security":[{"Authorization":[]}]}},"/{clientId}/blacklistentries/{entry}":{"get":{"tags":["Blocklist entries"],"summary":"Get information about a blocklist entry","description":"Get detailed information about a blocklist entry, such as pattern, reason for blocklisting or creation date.","operationId":"getBlacklistEntry","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}},{"name":"entry","in":"path","description":"Blocklist entry pattern<p><b>Note:</b> If the blocklist entry pattern contains special characters, the pattern must be URL-encoded. For example, use the code %2f for a forward slash (/), %252f for a double slash (//), %2B for a plus sign (+) etc.</p>","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The blocklist entry was retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestBlacklistEntry"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestBlacklistEntry"}}}},"404":{"description":"The blocklist entry could not be found. Ensure that the required parameters such as \"entry\" are correct and the blocklist entry exists."}},"security":[{"Authorization":[]}]},"delete":{"tags":["Blocklist entries"],"summary":"Delete a blocklist entry","operationId":"deleteBlacklistEntry","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}},{"name":"entry","in":"path","description":"Blocklist entry pattern<p><b>Note:</b> If the blocklist entry pattern contains special characters, the pattern must be URL-encoded. For example, use the code %2f for a forward slash (/), %252f for a double slash (//), %2B for a plus sign (+) etc.</p>","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The blocklist entry was deleted successfully."},"404":{"description":"The blocklist entry could not be found. Ensure that the required parameter is correct and the blocklist entry exists."}},"security":[{"Authorization":[]}]}},"/{clientId}/confirmations":{"get":{"tags":["Confirmations"],"summary":"Get information about all confirmation mailings","description":"Get detailed information about all confirmation mailings, such as status, type or creation date. You can filter mailings by media type and sort the result by specific criteria.","operationId":"selectConfirmationMailings","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"offset","in":"query","description":"Starting point of the result list <p><i>Default value</i> : 0</p>","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Maximum number of confirmation mailings<p><i>Default value</i> : 100</p>","schema":{"type":"integer","format":"int32"}},{"name":"mediaType","in":"query","description":"Filter mailings by media type<p><i>Available values</i> : email, sms, letter, push</p>","schema":{"type":"string"}},{"name":"resultView","in":"query","description":"Choose whether to retrieve a DETAILED view including all nodes (messages, recipient lists, target groups) or a SUMMARY of metadata.<p><b>Note:</b> The more campaigns you have, the more time the detailed view takes to load.</p>","schema":{"type":"string","default":"SUMMARY","enum":["SUMMARY","DETAILED"]}},{"name":"status","in":"query","description":"Filter mailings by status<p><i>Available values</i> : invalid, activationRequired, activated, canceled, paused, running, finished</p>","schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sort result by specific criteria","schema":{"type":"string","default":"created","enum":["id","name","description","status","created","modified","started","finished"]}},{"name":"folderId","in":"query","description":"Filter mailings assigned to a folder","schema":{"type":"integer","format":"int64"}},{"name":"direction","in":"query","description":"Sort order","schema":{"type":"string","enum":["ASC","DESC"]}}],"responses":{"200":{"description":"A list of all confirmation mailings was retrieved (empty if none exists).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestSmartCampaignStreamingCollection"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestSmartCampaignStreamingCollection"}}}},"400":{"description":"Invalid limit request. Change the limit to less than 10000."}},"security":[{"Authorization":[]}]},"post":{"tags":["Confirmations"],"summary":"Create a confirmation mail","operationId":"createConfirmationMailing","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/ConfirmationMailingRequestData"}}}},"responses":{"201":{"description":"Confirmation mail was created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestSmartCampaign"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestSmartCampaign"}}}},"400":{"description":"Request parameters were not valid"}},"security":[{"Authorization":[]}]}},"/{clientId}/confirmations/{confirmationMailId}":{"get":{"tags":["Confirmations"],"summary":"Get information about a confirmation mailing","description":"Get detailed information about a confirmation mailing, such as type, status or creation date.","operationId":"getConfirmationMailing","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}},{"name":"confirmationMailId","in":"path","description":"Confirmation mailing ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"The confirmation mailing was retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestSmartCampaign"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestSmartCampaign"}}}},"404":{"description":"The confirmation mailing could not be found. Ensure that the required parameters such as \"confirmationMailId\" are correct and the confirmation mailing exists."}},"security":[{"Authorization":[]}]},"delete":{"tags":["Confirmations"],"summary":"Delete a confirmation mailing","operationId":"deleteConfirmationMailing","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"string"}},{"name":"confirmationMailId","in":"path","description":"Confirmation mailing ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"The confirmation mailing was deleted successfully."}},"security":[{"Authorization":[]}]}},"/{clientId}/confirmations/{confirmationMailId}/message":{"post":{"tags":["Confirmations"],"summary":"Update a mailing","description":"Update information of a mailing, such as name, subject or content.","operationId":"updateCampaignMessage","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"confirmationMailId","in":"path","description":"Confirmation mailing ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/MessageRequestData"}}}},"responses":{"200":{"description":"The mailing was updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMessageNode"}},"application/vnd.optivo.broadmail.v1+json":{"schema":{"$ref":"#/components/schemas/RestMessageNode"}}}}},"security":[{"Authorization":[]}]}},"/{clientId}/confirmations/{confirmationMailId}/message/attachments":{"post":{"tags":["Confirmations"],"summary":"Add attachments into a campaign message. Only applicable for campaign message of type email","description":"Add attachments into a campaign message. With this operation you can add a single, or multiple attachments into a campaign message.","operationId":"addAttachments","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"confirmationMailId","in":"path","description":"Confirmation mailing ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"attachmentIds":{"type":"array","description":"A comma separated list of attachment ids to be added","items":{"type":"integer","format":"int64"}}}},"encoding":{"attachmentIds":{"explode":false}}}}},"responses":{"200":{"description":"The attachments were successfully added into campaign message."},"400":{"description":"The \"attachmentIds\" parameter is either empty or invalid, or the campaign mailing is of type FAX."},"404":{"description":"The campaign mailing was not found."},"405":{"description":"The campaign message is not of type EMAIL."}},"security":[{"Authorization":[]}]},"delete":{"tags":["Confirmations"],"summary":"Delete attachments of a campaign message. Only applicable for campaign message of type email","operationId":"deleteAttachments","parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"attachmentIds","in":"query","description":"A comma separated list of attachment ids to be deleted","required":true,"explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"confirmationMailId","in":"path","description":"Confirmation mailing ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"The attachments were successfully deleted from campaign message."},"400":{"description":"The \"attachmentIds\" parameter is empty, or the campaign mailing is of type FAX."},"404":{"description":"The campaign mailing was not found."},"405":{"description":"The campaign message is not of type EMAIL."}},"security":[{"Authorization":[]}]}},"/{clientId}/confirmations/{confirmationMailId}/message/content":{"get":{"tags":["Confirmations"],"summary":"Get the content of a mailing (email)","desc

# --- truncated at 32 KB (347 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/_original/optimizely-campaign-optimizely-campaign-rest-api-openapi.json