Optimizely · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Optimizely Campaign REST Message templates API
7 actions
7 updates
phrasing
extends
openapi/optimizely-message-templates-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Optimizely's API. It is a proposal applied on top of the contract, not a document Optimizely publishes.
What the actions change
x-apievangelist-phrasing
Targets 7
$.info
$.paths['/{clientId}/messagetemplates'].get
$.paths['/{clientId}/messagetemplates'].post
$.paths['/{clientId}/messagetemplates/{messageTemplateId}'].get
$.paths['/{clientId}/messagetemplates/{messageTemplateId}'].post
$.paths['/{clientId}/messagetemplates/{messageTemplateId}'].delete
$.paths['/{clientId}/messagetemplates/{messageTemplateId}/test'].post
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Optimizely Campaign REST Message templates API
version: 1.0.0
extends: openapi/optimizely-message-templates-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 6
- target: $.paths['/{clientId}/messagetemplates'].get
update:
x-apievangelist-phrasing:
intent: List message templates for a client
effect: read
questions:
- Which email message templates exist in my Optimizely Campaign client?
- Can I list only the message templates stored in one folder?
- How many templates come back per page, and can I sort them?
instructions:
- text: List the message templates for client {clientId}.
slots:
clientId: path.clientId
- text: Show message templates in folder {folderId} for client {clientId}, limited to {limit}.
slots:
folderId: query.folderId
clientId: path.clientId
limit: query.limit
method: generated
generated: '2026-09-26'
- target: $.paths['/{clientId}/messagetemplates'].post
update:
x-apievangelist-phrasing:
intent: Create or copy a message template
effect: write
questions:
- How do I create a new email message template from a CMS content template or a mailing?
- Can I duplicate an existing message template under a new name?
- What sender address and subject can I set on a new message template?
instructions:
- text: Copy message template {messageTemplateIdForCopy} as {name} for client {clientId}.
slots:
messageTemplateIdForCopy: requestBody.messageTemplateIdForCopy
name: requestBody.name
clientId: path.clientId
- text: Create message template {name} from mailing {mailingId} for client {clientId}.
slots:
name: requestBody.name
mailingId: requestBody.mailingId
clientId: path.clientId
- text: Create template {name} for client {clientId} with subject {subject} from sender {senderAddress}.
slots:
name: requestBody.name
clientId: path.clientId
subject: requestBody.subject
senderAddress: requestBody.senderAddress
method: generated
generated: '2026-09-26'
- target: $.paths['/{clientId}/messagetemplates/{messageTemplateId}'].get
update:
x-apievangelist-phrasing:
intent: Get details of one message template
effect: read
questions:
- What reply-to address and subject does a specific message template use?
- When was a particular message template created, and what format is it?
instructions:
- text: Get message template {messageTemplateId} for client {clientId}.
slots:
messageTemplateId: path.messageTemplateId
clientId: path.clientId
- text: Show the subject, format and reply-to of template {messageTemplateId} in client {clientId}.
slots:
messageTemplateId: path.messageTemplateId
clientId: path.clientId
method: generated
generated: '2026-09-26'
- target: $.paths['/{clientId}/messagetemplates/{messageTemplateId}'].post
update:
x-apievangelist-phrasing:
intent: Update an existing message template
effect: write
questions:
- How do I rename an existing message template or change its subject?
- Can I reset the reply-to address on a template I already have?
instructions:
- text: Rename existing template {messageTemplateId} in client {clientId} to {name}.
slots:
messageTemplateId: path.messageTemplateId
clientId: path.clientId
name: requestBody.name
- text: Change the subject of existing template {messageTemplateId} (client {clientId}) to {subject}, keeping name {name}.
slots:
messageTemplateId: path.messageTemplateId
clientId: path.clientId
subject: requestBody.subject
name: requestBody.name
method: generated
generated: '2026-09-26'
- target: $.paths['/{clientId}/messagetemplates/{messageTemplateId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a message template
effect: destructive
questions:
- Can I permanently delete a message template I no longer need?
- What is the call to remove a message template from a Campaign client?
instructions:
- text: Delete message template {messageTemplateId} from client {clientId}.
slots:
messageTemplateId: path.messageTemplateId
clientId: path.clientId
- text: Remove template {messageTemplateId} in client {clientId}.
slots:
messageTemplateId: path.messageTemplateId
clientId: path.clientId
method: generated
generated: '2026-09-26'
- target: $.paths['/{clientId}/messagetemplates/{messageTemplateId}/test'].post
update:
x-apievangelist-phrasing:
intent: Send a test mailing of a message template
effect: write
questions:
- How do I send a test email to check a template's content and layout before the real send?
- Which recipients receive a message template test, and can I override the subject?
instructions:
- text: Send a test of template {messageTemplateId} in client {clientId} to recipients {recipientIds} on list {recipientListId}.
slots:
messageTemplateId: path.messageTemplateId
clientId: path.clientId
recipientIds: requestBody.recipientIds
recipientListId: requestBody.recipientListId
- text: Test-send template {messageTemplateId} (client {clientId}) to {recipientIds} from list {recipientListId} with subject {subject}.
slots:
messageTemplateId: path.messageTemplateId
clientId: path.clientId
recipientIds: requestBody.recipientIds
recipientListId: requestBody.recipientListId
subject: requestBody.subject
method: generated
generated: '2026-09-26'