Optimizely · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Admin API V1 Page Urls API
10 actions
10 updates
phrasing
extends
openapi/optimizely-page-urls-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 10
$.info
$.paths['/api/v1/admin/PageUrls'].get
$.paths['/api/v1/admin/PageUrls'].post
$.paths['/api/v1/admin/PageUrls({id})'].get
$.paths['/api/v1/admin/PageUrls({id})'].put
$.paths['/api/v1/admin/PageUrls({id})'].delete
$.paths['/api/v1/admin/PageUrls({id})'].patch
$.paths['/api/v1/admin/PageUrls/Default.Default()'].get
$.paths['/api/v1/admin/pageurls/delete'].delete
$.paths['/api/v1/admin/pageurls({key})/customproperties({custompropertyKey})'].get
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 Admin API V1 Page Urls API
version: 1.0.0
extends: openapi/optimizely-page-urls-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: 9
- target: $.paths['/api/v1/admin/PageUrls'].get
update:
x-apievangelist-phrasing:
intent: List content page URLs
effect: read
questions:
- How do I list every page URL on my Optimizely Configured Commerce websites?
- Can I filter page URLs to one website or language?
instructions:
- text: List all page URLs.
- text: List page URLs matching {filter}, skipping the first {skip}.
slots:
filter: query.$filter
skip: query.$skip
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PageUrls'].post
update:
x-apievangelist-phrasing:
intent: Create a page URL
effect: write
questions:
- Can I give a content page a new URL with a publish window?
- Is it possible to hide a new page URL from search engines or navigation?
instructions:
- text: Create page URL {url} titled {title} for website {websiteId}.
slots:
url: requestBody.url
title: requestBody.title
websiteId: requestBody.websiteId
- text: Add URL {url} for node {nodeId} published from {publishOn} until {publishUntil}.
slots:
url: requestBody.url
nodeId: requestBody.nodeId
publishOn: requestBody.publishOn
publishUntil: requestBody.publishUntil
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PageUrls({id})'].get
update:
x-apievangelist-phrasing:
intent: Get one page URL
effect: read
questions:
- How can I see the settings on a single page URL record?
- Which fields can I select when fetching one page URL?
instructions:
- text: Show page URL {id}.
slots:
id: path.id
- text: Get page URL {id} returning only {select}.
slots:
id: path.id
select: query.$select
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PageUrls({id})'].put
update:
x-apievangelist-phrasing:
intent: Replace a page URL record
effect: write
questions:
- Can I overwrite a page URL record with all new values?
- What's the call to fully replace a page's URL entry?
instructions:
- text: Replace page URL {id} with URL {url} and title {title}.
slots:
id: path.id
url: requestBody.url
title: requestBody.title
- text: Overwrite page URL record {id} entirely for language {languageId}.
slots:
id: path.id
languageId: requestBody.languageId
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PageUrls({id})'].delete
update:
x-apievangelist-phrasing:
intent: Delete a page URL
effect: destructive
questions:
- How do I delete one page URL?
- Can I delete a page URL only if its ETag hasn't changed?
instructions:
- text: Delete page URL {id}.
slots:
id: path.id
- text: Delete page URL {id} if its ETag is {etag}.
slots:
id: path.id
etag: header.If-Match
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PageUrls({id})'].patch
update:
x-apievangelist-phrasing:
intent: Update a page URL's settings
effect: write
questions:
- Can I hide an existing page from search engines without resending the whole record?
- How do I let a page skip the sign-in requirement?
instructions:
- text: Patch page URL {id} so hide from search engines is {hideFromSearchEngines}.
slots:
id: path.id
hideFromSearchEngines: requestBody.hideFromSearchEngines
- text: 'Update page URL {id} to exclude from navigation: {excludeFromNavigation}.'
slots:
id: path.id
excludeFromNavigation: requestBody.excludeFromNavigation
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PageUrls/Default.Default()'].get
update:
x-apievangelist-phrasing:
intent: Get default values for a page URL
effect: read
questions:
- What defaults are pre-filled for a new page URL?
- Is there a blank page URL template?
instructions:
- text: Get the default page URL template.
- text: Show pre-filled values for a new page URL.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/pageurls/delete'].delete
update:
x-apievangelist-phrasing:
intent: Delete several page URLs
effect: destructive
questions:
- Can I bulk delete a batch of page URLs?
- How do I remove many page URL records at once?
instructions:
- text: Bulk delete page URLs {ids}.
slots:
ids: query.ids
- text: Remove every page URL listed in {ids}.
slots:
ids: query.ids
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/pageurls({key})/customproperties({custompropertyKey})'].get
update:
x-apievangelist-phrasing:
intent: Get a custom property on a page URL
effect: read
questions:
- Can I read a custom property stored on a page URL?
- Where are custom attributes of a page URL kept?
instructions:
- text: Get custom property {custompropertyKey} on page URL {key}.
slots:
custompropertyKey: path.custompropertyKey
key: path.key
- text: Show page URL {key}'s custom property {custompropertyKey}.
slots:
key: path.key
custompropertyKey: path.custompropertyKey
method: generated
generated: '2026-09-26'
Work with this as data
Every overlay 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 openapi overlays
4 MCP tools reach this
find_overlaysBrowse and filter every overlay in the catalog.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.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/optimizely-page-urls-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.
A second provider on the same verified email joins the account you already have.