Optimizely

Optimizely Confirmations API

Manage registration confirmations (opt-in emails)

GitHub OpenAPI
Business capability
Digital Marketing Management BC-400.60

Operations 21

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}/confirmations List confirmation mailings · Get information about all confirmation mailings #
Ask an LLM
“Which confirmation mailings do I have set up and what status is each one in?”
“Can I filter my confirmation mailings to only SMS or only email ones?”
Tell an agent
List all confirmation mailings for client {clientId}.
List client {clientId}'s confirmation mailings with media type {mediaType} and status {status}.
POST /{clientId}/confirmations Create a confirmation mailing · Create a confirmation mail #
Ask an LLM
“How do I set up a new confirmation email that goes to a recipient list?”
“What do I need to supply when creating a confirmation mailing, like sender and subject?”
Tell an agent
Create a confirmation mailing for client {clientId} with subject {subject} sent from {senderAddress} to recipient lists {recipientListIds}.
Set up a new confirmation mailing named {name} for client {clientId} using content {content}.
GET /{clientId}/confirmations/{confirmationMailId} Get a confirmation mailing · Get information about a confirmation mailing #
Ask an LLM
“What is the current status and type of one particular confirmation mailing?”
“When was a given confirmation mailing created?”
Tell an agent
Get confirmation mailing {confirmationMailId} for client {clientId}.
Show the details of confirmation mailing {confirmationMailId}.
DELETE /{clientId}/confirmations/{confirmationMailId} Delete a confirmation mailing · Delete a confirmation mailing #
Ask an LLM
“How do I permanently remove a confirmation mailing I no longer use?”
“Can I delete a confirmation mailing by its ID?”
Tell an agent destructive · confirm first
Delete confirmation mailing {confirmationMailId} for client {clientId}.
Remove confirmation mailing {confirmationMailId} entirely.
POST /{clientId}/confirmations/{confirmationMailId}/message Update a confirmation mailing's message · Update a mailing #
Ask an LLM
“How do I change the subject line or content of an existing confirmation mailing?”
“Can I change the reply-to address on a confirmation message after creating it?”
Tell an agent
Change the subject of confirmation mailing {confirmationMailId} to {subject}.
Update the message content of confirmation mailing {confirmationMailId} for client {clientId} to {content}.
POST /{clientId}/confirmations/{confirmationMailId}/message/attachments Attach files to a confirmation email · Add attachments into a campaign message. #
Ask an LLM
“How do I add a PDF or other attachment to a confirmation email?”
“Can I attach several files to a confirmation message in one request?”
Tell an agent
Add attachments {attachmentIds} to confirmation mailing {confirmationMailId}.
Attach files {attachmentIds} to the email message of confirmation mailing {confirmationMailId} for client {clientId}.
DELETE /{clientId}/confirmations/{confirmationMailId}/message/attachments Remove attachments from a confirmation email · Delete attachments of a campaign message. #
Ask an LLM
“How do I take an attachment off a confirmation email message?”
“Can I detach several files from a confirmation email at once?”
Tell an agent destructive · confirm first
Remove attachments {attachmentIds} from confirmation mailing {confirmationMailId}.
Detach files {attachmentIds} from client {clientId}'s confirmation mailing {confirmationMailId}.
GET /{clientId}/confirmations/{confirmationMailId}/message/content Get a confirmation email's content · Get the content of a mailing (email) #
Ask an LLM
“What does the body of my confirmation email actually contain?”
“Can I get the confirmation email content as plain text instead of HTML?”
Tell an agent
Get the email content of client {clientId}'s confirmation mailing {confirmationMailId}.
Fetch the content of confirmation mailing {confirmationMailId} as {Accept}.
GET /{clientId}/confirmations/{confirmationMailId}/message/test/{testMailingId} Get a test send report via the message path · Get information about the sending status of all recipients of a test mailing #
Ask an LLM
“Did every recipient of my test send of the confirmation message actually receive it?”
“Which recipients of a confirmation message test are still enqueued or failed, per the message-level report?”
Tell an agent
Get the message-level test sending report {testMailingId} for confirmation mailing {confirmationMailId}.
Show per-recipient status for message test {testMailingId} of confirmation mailing {confirmationMailId} under client {clientId}.
POST /{clientId}/confirmations/{confirmationMailId}/message/tracking/links/{trackingLinkId} Configure tracking for one email link · Update the tracking link configuration of a mailing #
Ask an LLM
“Can I turn off click tracking for a single link in the HTML version only?”
“How do I attach click profiles to one tracked link in a confirmation email?”
Tell an agent
Set HTML tracking on link {trackingLinkId} of client {clientId}'s confirmation mailing {confirmationMailId} to {htmlTracking}.
Assign click profiles {clickProfileIds} to tracking link {trackingLinkId} in confirmation mailing {confirmationMailId}.
GET /{clientId}/confirmations/{confirmationMailId}/message/tracking Get a confirmation email's tracking settings · Get information about the tracking configuration of a mailing #
Ask an LLM
“Is open tracking switched on for my confirmation email?”
“What are the overall click and open tracking settings of a confirmation mailing?”
Tell an agent
Show the tracking configuration of confirmation mailing {confirmationMailId}.
Check whether open and click tracking are enabled on confirmation mailing {confirmationMailId} for client {clientId}.
POST /{clientId}/confirmations/{confirmationMailId}/message/tracking Change a confirmation email's tracking settings · Update the tracking configuration of a mailing #
Ask an LLM
“How do I turn on open tracking for an entire confirmation mailing?”
“Can I disable click tracking across all links of a confirmation email?”
Tell an agent
Set open tracking on client {clientId}'s confirmation mailing {confirmationMailId} to {openTrackingEnabled}.
Set click tracking for confirmation mailing {confirmationMailId} to {clickTrackingEnabled}.
GET /{clientId}/confirmations/{confirmationMailId}/recipientLists Get a confirmation mailing's Recipients node · Get information about a "Recipients" node #
Ask an LLM
“Which recipient lists feed a confirmation mailing's Recipients node?”
“What node follows the Recipients step in my confirmation mailing flow?”
Tell an agent
Get the Recipients node of confirmation mailing {confirmationMailId}.
Show the recipient node ID and successor for client {clientId}'s confirmation mailing {confirmationMailId}.
POST /{clientId}/confirmations/{confirmationMailId}/recipientLists Set the recipient lists of a confirmation mailing · Create or update a "Recipients" node #
Ask an LLM
“How do I change which recipient lists a confirmation mailing targets?”
“Can I create the Recipients node for a confirmation mailing if it does not exist yet?”
Tell an agent
Point the Recipients node of client {clientId}'s confirmation mailing {confirmationMailId} at recipient lists {recipientListIds}.
Create a Recipients node on confirmation mailing {confirmationMailId} with lists {recipientListIds} followed by node {successorNodeId}.
GET /{clientId}/confirmations/{confirmationMailId}/test/{testMailingId} Get a confirmation mailing's test send report · Get information about the sending status of all recipients of a test mailing #
Ask an LLM
“Where can I check the delivery status of a test send made for a confirmation mailing itself?”
“Did any recipients fail in the mailing-level test report of a confirmation mailing?”
Tell an agent
Get the mailing-level test report {testMailingId} for confirmation mailing {confirmationMailId}.
Show who was sent, enqueued or failed in test {testMailingId} of client {clientId}'s confirmation mailing {confirmationMailId}.
POST /{clientId}/confirmations/{confirmationMailId}/test Send a test of a confirmation mailing · Send a test mailing #
Ask an LLM
“How do I send a test of my confirmation email to a few people before going live?”
“Can I override the subject line when sending a test confirmation mailing?”
Tell an agent
Send a test of client {clientId}'s confirmation mailing {confirmationMailId} to recipients {recipientIds} from list {recipientListId}.
Test-send confirmation mailing {confirmationMailId} to {recipientIds} in list {recipientListId} with subject {subject}.
GET /{clientId}/confirmations/{confirmationMailId}/report Get a confirmation mailing's performance report · Get a campaign report #
Ask an LLM
“How many opens, clicks and bounces has my confirmation email had?”
“What is the unsubscribe count for a confirmation mailing?”
Tell an agent
Get the campaign report for confirmation mailing {confirmationMailId}.
Show recipients, opens, clicks and bounces for client {clientId}'s confirmation mailing {confirmationMailId}.
POST /{clientId}/confirmations/{confirmationMailId}/start Start a confirmation mailing · Start a confirmation mailing #
Ask an LLM
“How do I activate a confirmation mailing so it starts sending?”
“Can I switch on a confirmation mailing once it is ready?”
Tell an agent
Start confirmation mailing {confirmationMailId}.
Activate client {clientId}'s confirmation mailing {confirmationMailId}.
POST /{clientId}/confirmations/{confirmationMailId}/stop Stop a confirmation mailing · Stop a confirmation mailing #
Ask an LLM
“How do I pause a running confirmation mailing so it stops sending?”
“Can I halt a confirmation mailing that is currently active?”
Tell an agent
Stop confirmation mailing {confirmationMailId}.
Halt sending of client {clientId}'s confirmation mailing {confirmationMailId}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-confirmations-api-openapi.yml

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-confirmations-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-confirmations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Optimizely Campaign REST Confirmations API
  description: This documentation lists all available resources and endpoints of the Optimizely Campaign REST API.
  version: '1'
servers:
- url: https://api.campaign.episerver.net/rest
tags:


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