Optimizely · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Admin API V1 Integration Job Parameters API
10 actions
10 updates
phrasing
extends
openapi/optimizely-integration-job-parameters-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/IntegrationJobParameters'].get
$.paths['/api/v1/admin/IntegrationJobParameters'].post
$.paths['/api/v1/admin/IntegrationJobParameters({id})'].get
$.paths['/api/v1/admin/IntegrationJobParameters({id})'].put
$.paths['/api/v1/admin/IntegrationJobParameters({id})'].delete
$.paths['/api/v1/admin/IntegrationJobParameters({id})'].patch
$.paths['/api/v1/admin/IntegrationJobParameters/Default.Default()'].get
$.paths['/api/v1/admin/integrationjobparameters/delete'].delete
$.paths['/api/v1/admin/integrationjobparameters({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 Integration Job Parameters API
version: 1.0.0
extends: openapi/optimizely-integration-job-parameters-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/IntegrationJobParameters'].get
update:
x-apievangelist-phrasing:
intent: List integration job parameters
effect: read
questions:
- What parameter values were passed to our integration jobs?
- Can I filter job parameters down to a single integration job run?
- How many integration job parameters are stored?
instructions:
- text: List all integration job parameters.
- text: List integration job parameters where {filter}.
slots:
filter: query.$filter
- text: Show integration job parameters with the related job expanded as {expand}.
slots:
expand: query.$expand
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationJobParameters'].post
update:
x-apievangelist-phrasing:
intent: Add a parameter value to an integration job
effect: write
questions:
- How do I supply a parameter value for an integration job before it runs?
- Can a job parameter be tied to a specific job definition step parameter?
instructions:
- text: Add parameter value {value} to integration job {integrationJobId}.
slots:
value: requestBody.value
integrationJobId: requestBody.integrationJobId
- text: Set job definition parameter {jobDefinitionParameterId} to {value} on integration job {integrationJobId}.
slots:
jobDefinitionParameterId: requestBody.jobDefinitionParameterId
value: requestBody.value
integrationJobId: requestBody.integrationJobId
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationJobParameters({id})'].get
update:
x-apievangelist-phrasing:
intent: Get an integration job parameter
effect: read
questions:
- What value does a particular integration job parameter hold?
- Can I fetch one job parameter record by its id?
instructions:
- text: Get integration job parameter {id}.
slots:
id: path.id
- text: Show the value of job parameter {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationJobParameters({id})'].put
update:
x-apievangelist-phrasing:
intent: Replace an integration job parameter
effect: write
questions:
- Can I rewrite a job parameter record entirely, including which job it belongs to?
- Does replacing a job parameter clear fields I leave out?
instructions:
- text: Replace integration job parameter {id} with value {value}.
slots:
id: path.id
value: requestBody.value
- text: Overwrite job parameter {id} so it belongs to integration job {integrationJobId} with value {value}.
slots:
id: path.id
integrationJobId: requestBody.integrationJobId
value: requestBody.value
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationJobParameters({id})'].delete
update:
x-apievangelist-phrasing:
intent: Delete an integration job parameter
effect: destructive
questions:
- How do I remove a parameter I set on an integration job by mistake?
- Can I protect a job parameter delete with an If-Match ETag?
instructions:
- text: Delete integration job parameter {id}.
slots:
id: path.id
- text: Delete job parameter {id} if its ETag still equals {etag}.
slots:
id: path.id
etag: header.If-Match
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationJobParameters({id})'].patch
update:
x-apievangelist-phrasing:
intent: Change the value of an integration job parameter
effect: write
questions:
- Can I just change the value of one job parameter?
- Is a partial update supported for integration job parameters?
instructions:
- text: Change the value of job parameter {id} to {value}.
slots:
id: path.id
value: requestBody.value
- text: Patch job parameter {id} to use step parameter {jobDefinitionStepParameterId}.
slots:
id: path.id
jobDefinitionStepParameterId: requestBody.jobDefinitionStepParameterId
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationJobParameters/Default.Default()'].get
update:
x-apievangelist-phrasing:
intent: Call the integration job parameters Default function
effect: read
questions:
- What does the Default function on integration job parameters return?
- Is there a default integration job parameter entry?
instructions:
- text: Call the Default function on integration job parameters.
- text: Fetch the default integration job parameter result.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/integrationjobparameters/delete'].delete
update:
x-apievangelist-phrasing:
intent: Bulk delete integration job parameters
effect: destructive
questions:
- Can I clear several integration job parameters in one request?
- Is there a bulk delete by id list for job parameters?
instructions:
- text: Delete integration job parameters {ids}.
slots:
ids: query.ids
- text: Bulk remove the job parameters with ids {ids}.
slots:
ids: query.ids
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/integrationjobparameters({key})/customproperties({custompropertyKey})'].get
update:
x-apievangelist-phrasing:
intent: Get a custom property of an integration job parameter
effect: read
questions:
- Can I read a custom property attached to an integration job parameter?
- Where is a custom value for a job parameter stored?
instructions:
- text: Get custom property {custompropertyKey} of job parameter {key}.
slots:
custompropertyKey: path.custompropertyKey
key: path.key
- text: Show custom value {custompropertyKey} on integration job parameter {key}.
slots:
custompropertyKey: path.custompropertyKey
key: path.key
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-integration-job-parameters-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.