Optimizely · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Optimizely Campaign REST Folders API
8 actions
8 updates
phrasing
extends
openapi/optimizely-folders-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 8
$.info
$.paths['/{clientId}/folders'].get
$.paths['/{clientId}/folders'].post
$.paths['/{clientId}/folders/{folderId}/assign'].post
$.paths['/{clientId}/folders/{folderId}'].get
$.paths['/{clientId}/folders/{folderId}'].post
$.paths['/{clientId}/folders/{folderId}'].delete
$.paths['/{clientId}/folders/{folderId}/unassign'].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 Folders API
version: 1.0.0
extends: openapi/optimizely-folders-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: 7
- target: $.paths['/{clientId}/folders'].get
update:
x-apievangelist-phrasing:
intent: List campaign folders
effect: read
questions:
- Which folders exist in my campaign client, with their parents and children?
- Can I list only the root folders, or only folders of one type?
- Is there a limit on how many folders come back in one call?
instructions:
- text: List all folders in client {clientId}.
slots:
clientId: path.clientId
- text: List only root folders of type {type} in client {clientId}.
slots:
clientId: path.clientId
type: query.type
- text: Show folders containing entity {entityId} in client {clientId}.
slots:
clientId: path.clientId
entityId: query.entityId
method: generated
generated: '2026-09-26'
- target: $.paths['/{clientId}/folders'].post
update:
x-apievangelist-phrasing:
intent: Create a campaign folder
effect: write
questions:
- How do I create a folder to organize my mailings?
- Can I nest a new folder under an existing parent folder?
instructions:
- text: Create a {folderType} folder named {name} in client {clientId}.
slots:
clientId: path.clientId
folderType: requestBody.folderType
name: requestBody.name
- text: Create folder {name} of type {folderType} under parent {parentId} in client {clientId}.
slots:
clientId: path.clientId
name: requestBody.name
folderType: requestBody.folderType
parentId: requestBody.parentId
method: generated
generated: '2026-09-26'
- target: $.paths['/{clientId}/folders/{folderId}/assign'].post
update:
x-apievangelist-phrasing:
intent: Put an item into a folder
effect: write
questions:
- Can I file a mailing or recipient list into a folder?
- What kinds of items can be assigned to a folder, like templates or images?
instructions:
- text: Assign entity {entityId} to folder {folderId} in client {clientId}.
slots:
clientId: path.clientId
folderId: path.folderId
entityId: requestBody.entityId
- text: File mailing {entityId} into folder {folderId} for client {clientId}.
slots:
clientId: path.clientId
folderId: path.folderId
entityId: requestBody.entityId
method: generated
generated: '2026-09-26'
- target: $.paths['/{clientId}/folders/{folderId}'].get
update:
x-apievangelist-phrasing:
intent: Get details of one folder
effect: read
questions:
- What are the name and creation date of a specific folder?
- How do I look up a single folder by its ID?
instructions:
- text: Get folder {folderId} in client {clientId}.
slots:
clientId: path.clientId
folderId: path.folderId
- text: Show the name and creation time of folder {folderId} for client {clientId}.
slots:
clientId: path.clientId
folderId: path.folderId
method: generated
generated: '2026-09-26'
- target: $.paths['/{clientId}/folders/{folderId}'].post
update:
x-apievangelist-phrasing:
intent: Rename or move a folder
effect: write
questions:
- Can I rename a folder or move it to a different parent?
- Is it possible to change a folder's type after creating it?
instructions:
- text: Rename folder {folderId} in client {clientId} to {name}, keeping type {folderType}.
slots:
clientId: path.clientId
folderId: path.folderId
name: requestBody.name
folderType: requestBody.folderType
- text: Move folder {folderId} under parent {parentId} in client {clientId}, named {name}, type {folderType}.
slots:
clientId: path.clientId
folderId: path.folderId
parentId: requestBody.parentId
name: requestBody.name
folderType: requestBody.folderType
method: generated
generated: '2026-09-26'
- target: $.paths['/{clientId}/folders/{folderId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an empty folder
effect: destructive
questions:
- Can I delete a folder that still has items in it?
- What's needed to remove a folder I no longer use?
instructions:
- text: Delete empty folder {folderId} in client {clientId}.
slots:
clientId: path.clientId
folderId: path.folderId
- text: Remove folder {folderId} from client {clientId}.
slots:
clientId: path.clientId
folderId: path.folderId
method: generated
generated: '2026-09-26'
- target: $.paths['/{clientId}/folders/{folderId}/unassign'].post
update:
x-apievangelist-phrasing:
intent: Take an item out of a folder
effect: write
questions:
- How do I remove a mailing from a folder without deleting it?
- Can I unassign a recipient list or image from its folder?
instructions:
- text: Unassign entity {entityId} from folder {folderId} in client {clientId}.
slots:
clientId: path.clientId
folderId: path.folderId
entityId: requestBody.entityId
- text: Take template {entityId} out of folder {folderId} for client {clientId}.
slots:
clientId: path.clientId
folderId: path.folderId
entityId: requestBody.entityId
method: generated
generated: '2026-09-26'