How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Optimizely Transactional mails API

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

Optimizely Transactional mails API is one of 420 APIs that Optimizely publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Transactional mails. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 24 operations across 17 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 1.

Requests are made against a single base URL, https://api.campaign.episerver.net/rest.

24 operations 17 paths 27 schemas 2 DELETE11 GET11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1
Base URL
https://exp.mcp.opal.optimizely.com/mcp
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Optimizely Transactional mails API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Authorization).

Paths & Operations 24

Across 17 paths, the API surfaces 24 operations — 2 DELETE, 11 GET, 11 POST. Each is listed below with its method, path, parameters, and response codes.

Transactional mails 24

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

GET
/{clientId}/transactionalmail
Get information about all transactional mails
selectTransactionalCampaigns 9 params → 200400
POST
/{clientId}/transactionalmail
Create a transactional mail
createTransactionalMailing 1 param body → 201400
GET
/{clientId}/transactionalmail/{transactionalMailId}
Get information about a transactional mail
getTransactionalMailing 2 params → 200
DELETE
/{clientId}/transactionalmail/{transactionalMailId}
Delete a transactional mail
deleteTransactionalMailing 2 params → 204409
POST
/{clientId}/transactionalmail/{transactionalMailId}/message
Update a mailing
updateCampaignMessage_3 2 params body → 200
POST
/{clientId}/transactionalmail/{transactionalMailId}/message/attachments
Add attachments into a campaign message. Only applicable for campaign message of type email
addAttachments_2 2 params body → 200400404405
DELETE
/{clientId}/transactionalmail/{transactionalMailId}/message/attachments
Delete attachments of a campaign message. Only applicable for campaign message of type email
deleteAttachments_2 3 params → 204400404405
GET
/{clientId}/transactionalmail/{transactionalMailId}/message/content
Get the content of a mailing (email)
getCampaignMessageContent_2 4 params → 200404406
POST
/{clientId}/transactionalmail/{transactionalMailId}/message/content
Update the content of a mailing
storeCampaignMessageContent_2 2 params body → 200409
GET
/{clientId}/transactionalmail/{transactionalMailId}/message/test/{testMailingId}
Get information about the sending status of all recipients of a test mailing
getTestMailingReport_3 3 params → 200
GET
/{clientId}/transactionalmail/{transactionalMailId}/message/tracking/links/{trackingLinkId}
Get information about a tracking link of a mailing
getTrackingLink_2 3 params → 200
POST
/{clientId}/transactionalmail/{transactionalMailId}/message/tracking/links/{trackingLinkId}
Update the tracking link configuration of a mailing
updateLinkTracking_2 3 params body → 200
GET
/{clientId}/transactionalmail/{transactionalMailId}/message/tracking/links
Get information about all tracking links of a mailing
getTrackingLinks_2 2 params → 200400
GET
/{clientId}/transactionalmail/{transactionalMailId}/message/tracking
Get information about the tracking configuration of a mailing
getTrackingConfiguration_2 2 params → 200
POST
/{clientId}/transactionalmail/{transactionalMailId}/message/tracking
Update the tracking configuration of a mailing
updateTrackingConfiguration_2 2 params body → 200
GET
/{clientId}/transactionalmail/{transactionalMailId}/recipientLists
Get information about a "Recipients" node
getRecipientListsNodeForSCMailing_2 2 params → 200404
POST
/{clientId}/transactionalmail/{transactionalMailId}/recipientLists
Create or update a "Recipients" node
createOrUpdateRecipientListsNode_2 2 params body → 200201404
GET
/{clientId}/transactionalmail/{transactionalMailId}/test/{testMailingId}
Get information about the sending status of all recipients of a test mailing
getTestMailingReport_4 3 params → 200
POST
/{clientId}/transactionalmail/{transactionalMailId}/test
Send a test mailing
startTestMailing_4 2 params body → 202400
POST
/{clientId}/transactionalmail/{transactionalMailId}/send
Send a transactional mail
sendTransactionalMailing 2 params body → 202400
GET
/{clientId}/transactionalmail/{transactionalMailId}/report
Get a campaign report
getReport_2 2 params → 200
POST
/{clientId}/transactionalmail/{transactionalMailId}/start
Start a transactional mail
startTransactionalMailing 2 params → 200409
POST
/{clientId}/transactionalmail/{transactionalMailId}/stop
Stop a transactional mail
stopTransactionalMailing 2 params → 200409
GET
/{clientId}/transactionalmail/status
Get the sending status of a sent transactional mail
retrieveSendStatus 2 params → 200

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are RestMessageNode (34 properties), MessageRequestData (27 properties), EventBasedMailingRequestData (24 properties), RestSmartCampaign (15 properties). Each schema is shown below with its type and property counts.

SendTransactionalMailingRequestData
object
4 properties 2 required
RestTrackingLink
object
9 properties
RestRecipientListsNode
object
5 properties
RestMailId
object
1 property
RestRecipients
object
Number of total, skipped and in-queue recipients
4 properties
TrackingLinkConfigurationRequestData
object
4 properties
RestClicks
object
Number of unique and total clicks
2 properties
Filter
object
1 property
RecipientListsRequestData
object
2 properties 1 required
RestSmartCampaignStreamingCollection
object
5 properties
CampaignMailingRestReport
object
8 properties
MultiRequest
object
1 property
MessageRequestData
object
27 properties
RestOpens
object
Number of unique and total opens
2 properties
EventBasedMailingRequestData
object
24 properties 4 required
RestMessageNode
object
34 properties
RestBounces
object
Number of hard and soft bounces
2 properties
TrackingConfigurationRequestData
object
5 properties
RestSmartCampaign
object
15 properties
RestTrackingConfiguration
object
6 properties
TestMailingStartedReport
object
5 properties
RestApiLink
object
2 properties
Point
object
Grid location point
2 properties
TestMailingReport
object
7 properties
RestTargetGroupNode
object
6 properties
RestSendStatus
object
2 properties
TestMailingRequestData
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

optimizely-transactional-mails-api-openapi.yml Raw ↑

Other APIs Optimizely publishes across the network.

Optimizely Remote MCP Server — Experimentation
Optimizely Assets API
Optimizely Attributes API
Optimizely Audiences API
Optimizely Campaigns API
Optimizely Catalog Entries API
Optimizely Catalog Entry Relations API
Optimizely Catalog Nodes API
Optimizely Catalogs API
Optimizely Content API
Optimizely Content Types API
Optimizely Customers API
Where this information came from

This is an independent, third-party profile of Optimizely Transactional mails 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.