Optimizely

Optimizely Transactional mails API

Manage transactional mails that are triggered by a recipient action or event

GitHub OpenAPI
Business capability
Digital Marketing Management BC-400.60

Operations 24

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}/transactionalmail List all transactional mails · Get information about all transactional mails #
Ask an LLM
“How do I see every transactional mail set up in my Optimizely Campaign client?”
“Can I filter my transactional mails by status or media type such as email or SMS?”
Tell an agent
List all transactional mails for client {clientId}.
Show the transactional mails for client {clientId} with status {status}.
POST /{clientId}/transactionalmail Create a transactional mail · Create a transactional mail #
Ask an LLM
“How do I set up a new transactional mail with a subject, sender and content?”
“Can a new transactional mail be tied to one or more recipient lists when I create it?”
Tell an agent
Create a transactional mail for client {clientId} with subject {subject} sent from {senderAddress} to recipient lists {recipientListIds}, content: {content}.
Set up a new transactional mail named {name} under client {clientId}.
GET /{clientId}/transactionalmail/{transactionalMailId} Get details of one transactional mail · Get information about a transactional mail #
Ask an LLM
“What is the current status and type of a specific transactional mail?”
“When was a given transactional mail created?”
Tell an agent
Get the details of transactional mail {transactionalMailId} for client {clientId}.
Look up the status of transactional mail {transactionalMailId}.
DELETE /{clientId}/transactionalmail/{transactionalMailId} Delete a transactional mail · Delete a transactional mail #
Ask an LLM
“How do I permanently remove a transactional mail I no longer use?”
“Can I delete a transactional mail from my Campaign client?”
Tell an agent destructive · confirm first
Delete transactional mail {transactionalMailId} from client {clientId}.
Remove the transactional mail {transactionalMailId}.
POST /{clientId}/transactionalmail/{transactionalMailId}/message Update a transactional mail's message settings · Update a mailing #
Ask an LLM
“How do I change the subject or sender of an existing transactional mail?”
“Can I edit the name, reply-to address or push settings of a transactional mail's message?”
Tell an agent
Change the subject of transactional mail {transactionalMailId} for client {clientId} to {subject}.
Set the sender address of transactional mail {transactionalMailId} to {senderAddress} and the sender name to {senderName}.
POST /{clientId}/transactionalmail/{transactionalMailId}/message/attachments Attach files to a transactional email · Add attachments into a campaign message. #
Ask an LLM
“How do I add attachments to a transactional email message?”
“Can I attach several files to a transactional mail at once?”
Tell an agent
Attach files {attachmentIds} to transactional mail {transactionalMailId} for client {clientId}.
Add attachment {attachmentIds} to the email of transactional mail {transactionalMailId}.
DELETE /{clientId}/transactionalmail/{transactionalMailId}/message/attachments Remove attachments from a transactional email · Delete attachments of a campaign message. #
Ask an LLM
“How do I take an attachment off a transactional email?”
“Can I detach multiple files from a transactional mail in one call?”
Tell an agent destructive · confirm first
Remove attachments {attachmentIds} from transactional mail {transactionalMailId} for client {clientId}.
Detach file {attachmentIds} from the transactional mail {transactionalMailId}.
GET /{clientId}/transactionalmail/{transactionalMailId}/message/content Get the content of a transactional email · Get the content of a mailing (email) #
Ask an LLM
“Can I download the HTML or plain-text body of a transactional email?”
“Where do I read the current content of a transactional mail?”
Tell an agent
Fetch the email content of transactional mail {transactionalMailId} for client {clientId}.
Get the body of transactional mail {transactionalMailId} as {Accept}.
POST /{clientId}/transactionalmail/{transactionalMailId}/message/content Replace the content of a transactional mail · Update the content of a mailing #
Ask an LLM
“How do I upload new HTML or plain-text content for a transactional mail?”
“Can I send multipart content with both HTML and text for a transactional email?”
Tell an agent
Upload new content {content} to transactional mail {transactionalMailId} for client {clientId}.
Replace the body of transactional mail {transactionalMailId} with this HTML.
GET /{clientId}/transactionalmail/{transactionalMailId}/message/test/{testMailingId} Get recipient status of a test message send · Get information about the sending status of all recipients of a test mailing #
Ask an LLM
“Did every recipient of my transactional message test actually get it?”
“Which test recipients are still enqueued versus sent under the message test endpoint?”
Tell an agent
Show the message-level test report {testMailingId} for transactional mail {transactionalMailId} in client {clientId}.
Check per-recipient sending status of message test {testMailingId} on transactional mail {transactionalMailId}.
POST /{clientId}/transactionalmail/{transactionalMailId}/message/tracking/links/{trackingLinkId} Change tracking for one link in a transactional mail · 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 of a transactional mail?”
“How do I assign click profiles to a specific tracked link?”
Tell an agent
Set HTML tracking of link {trackingLinkId} in transactional mail {transactionalMailId} for client {clientId} to {htmlTracking}.
Assign click profiles {clickProfileIds} to tracking link {trackingLinkId}.
GET /{clientId}/transactionalmail/{transactionalMailId}/message/tracking Get a transactional mail's tracking settings · Get information about the tracking configuration of a mailing #
Ask an LLM
“Is open and click tracking switched on for my transactional mail?”
“What are the default link tracking settings on a transactional mail?”
Tell an agent
Show the tracking configuration of transactional mail {transactionalMailId} for client {clientId}.
Check whether opens and clicks are tracked on transactional mail {transactionalMailId}.
POST /{clientId}/transactionalmail/{transactionalMailId}/message/tracking Change a transactional mail's tracking settings · Update the tracking configuration of a mailing #
Ask an LLM
“How do I enable open tracking for a transactional mail?”
“Can I turn click tracking off for the whole transactional mail?”
Tell an agent
Turn open tracking {openTrackingEnabled} on transactional mail {transactionalMailId} for client {clientId}.
Set click tracking to {clickTrackingEnabled} for transactional mail {transactionalMailId}.
GET /{clientId}/transactionalmail/{transactionalMailId}/recipientLists Get the Recipients node of a transactional mail · Get information about a "Recipients" node #
Ask an LLM
“Which recipient lists feed the Recipients node of my transactional mail?”
“What is the successor node after the Recipients node of a transactional mail?”
Tell an agent
Get the Recipients node of transactional mail {transactionalMailId} for client {clientId}.
Show the recipient node and grid location for transactional mail {transactionalMailId}.
POST /{clientId}/transactionalmail/{transactionalMailId}/recipientLists Set the recipient lists of a transactional mail · Create or update a "Recipients" node #
Ask an LLM
“How do I change which recipient lists a transactional mail targets?”
“Can I create the Recipients node for a transactional mail and link a successor node?”
Tell an agent
Point the Recipients node of transactional mail {transactionalMailId} for client {clientId} at lists {recipientListIds}.
Link the Recipients node of transactional mail {transactionalMailId} to successor node {successorNodeId}.
GET /{clientId}/transactionalmail/{transactionalMailId}/test/{testMailingId} Get recipient status of a transactional test send · Get information about the sending status of all recipients of a test mailing #
Ask an LLM
“How do I check the result of a test mailing I sent for a transactional mail?”
“Which recipients of my transactional mail test failed or are still sending?”
Tell an agent
Get the report for test send {testMailingId} of transactional mail {transactionalMailId} in client {clientId}.
Show sending status for each recipient of test {testMailingId} started on transactional mail {transactionalMailId}.
POST /{clientId}/transactionalmail/{transactionalMailId}/test Send a test of a transactional mail · Send a test mailing #
Ask an LLM
“Can I preview a transactional mail by sending a test to a few recipients first?”
“How do I send a test with a different subject or sender address?”
Tell an agent
Send a test of transactional mail {transactionalMailId} for client {clientId} to recipients {recipientIds} from list {recipientListId}.
Test transactional mail {transactionalMailId} with subject {subject} for recipient {recipientIds} in list {recipientListId}.
POST /{clientId}/transactionalmail/{transactionalMailId}/send Send a transactional mail to a recipient · Send a transactional mail #
Ask an LLM
“How do I trigger a transactional email like an order confirmation to one person?”
“Can I pass personalization data along when sending a transactional mail?”
Tell an agent
Send transactional mail {transactionalMailId} for client {clientId} to {recipientId} via list {recipientListId}.
Deliver transactional mail {transactionalMailId} to {recipientId} using recipient list {recipientListId} with attachment token {personalizedAttachmentsToken}.
GET /{clientId}/transactionalmail/{transactionalMailId}/report Get performance report of a transactional mail · Get a campaign report #
Ask an LLM
“How many opens, clicks and bounces has my transactional mail had?”
“What does the campaign report say about a transactional mail's recipients?”
Tell an agent
Get the campaign report for transactional mail {transactionalMailId} in client {clientId}.
Show opens, clicks and bounces for transactional mail {transactionalMailId}.
POST /{clientId}/transactionalmail/{transactionalMailId}/start Activate a transactional mail · Start a transactional mail #
Ask an LLM
“How do I activate a transactional mail so it can start sending?”
“Can I restart a transactional mail that I stopped earlier?”
Tell an agent
Start transactional mail {transactionalMailId} for client {clientId}.
Activate the transactional mail {transactionalMailId}.
POST /{clientId}/transactionalmail/{transactionalMailId}/stop Stop a transactional mail · Stop a transactional mail #
Ask an LLM
“How do I pause a transactional mail so it stops sending?”
“Can I halt a running transactional mail without deleting it?”
Tell an agent
Stop transactional mail {transactionalMailId} for client {clientId}.
Halt sending of the transactional mail {transactionalMailId}.
GET /{clientId}/transactionalmail/status Check delivery status of a sent transactional mail · Get the sending status of a sent transactional mail #
Ask an LLM
“Was a transactional message I already sent actually delivered?”
“Where can I look up the sending status of one sent transactional mail by its mail ID?”
Tell an agent
Check the sending status of sent mail {mailId} for client {clientId}.
Look up whether transactional send {mailId} went out.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-transactional-mails-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-transactional-mails-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-transactional-mails-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Optimizely Campaign REST Transactional mails 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 (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-transactional-mails-api-openapi.yml