Optimizely · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Admin API V1 Restriction Group Customers API
10 actions
10 updates
phrasing
extends
openapi/optimizely-restriction-group-customers-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/RestrictionGroupCustomers'].get
$.paths['/api/v1/admin/RestrictionGroupCustomers'].post
$.paths['/api/v1/admin/RestrictionGroupCustomers({id})'].get
$.paths['/api/v1/admin/RestrictionGroupCustomers({id})'].put
$.paths['/api/v1/admin/RestrictionGroupCustomers({id})'].delete
$.paths['/api/v1/admin/RestrictionGroupCustomers({id})'].patch
$.paths['/api/v1/admin/RestrictionGroupCustomers/Default.Default()'].get
$.paths['/api/v1/admin/restrictiongroupcustomers/delete'].delete
$.paths['/api/v1/admin/restrictiongroupcustomers({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 Restriction Group Customers API
version: 1.0.0
extends: openapi/optimizely-restriction-group-customers-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/RestrictionGroupCustomers'].get
update:
x-apievangelist-phrasing:
intent: List customer assignments to restriction groups
effect: read
questions:
- Which customers are assigned to product restriction groups?
- Can I filter restriction group assignments by customer or group?
instructions:
- text: List all restriction group customer assignments.
- text: List restriction group customers matching {filter}.
slots:
filter: query.$filter
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupCustomers'].post
update:
x-apievangelist-phrasing:
intent: Assign a customer to a restriction group
effect: write
questions:
- How do I put a customer into a restriction group so their catalog is limited?
- Can a restriction apply only when the customer is the bill-to or only the ship-to?
instructions:
- text: Add customer {customerId} to restriction group {restrictionGroupId}.
slots:
customerId: requestBody.customerId
restrictionGroupId: requestBody.restrictionGroupId
- text: Assign customer {customerId} to group {restrictionGroupId}, applying when ship-to is {applyWhenShipTo}.
slots:
customerId: requestBody.customerId
restrictionGroupId: requestBody.restrictionGroupId
applyWhenShipTo: requestBody.applyWhenShipTo
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupCustomers({id})'].get
update:
x-apievangelist-phrasing:
intent: Get one restriction group assignment
effect: read
questions:
- How do I look up a single customer-to-restriction-group assignment?
- Can I expand the customer on one restriction group assignment?
instructions:
- text: Get restriction group customer {id}.
slots:
id: path.id
- text: Show restriction group assignment {id} with {expand} expanded.
slots:
id: path.id
expand: query.$expand
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupCustomers({id})'].put
update:
x-apievangelist-phrasing:
intent: Replace a restriction group assignment
effect: write
questions:
- How do I overwrite a customer's restriction group assignment in full?
- Does replacing an assignment reset the bill-to and ship-to flags?
instructions:
- text: Replace assignment {id} with customer {customerId} in group {restrictionGroupId}.
slots:
id: path.id
customerId: requestBody.customerId
restrictionGroupId: requestBody.restrictionGroupId
- text: Fully overwrite restriction group customer record {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupCustomers({id})'].delete
update:
x-apievangelist-phrasing:
intent: Remove a customer from a restriction group
effect: destructive
questions:
- How do I lift a product restriction by removing the customer from the group?
- Can I make the removal conditional on the record's ETag?
instructions:
- text: Delete restriction group assignment {id}.
slots:
id: path.id
- text: Remove assignment {id} if its ETag is {ifMatch}.
slots:
id: path.id
ifMatch: header.If-Match
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupCustomers({id})'].patch
update:
x-apievangelist-phrasing:
intent: Change when a restriction applies to a customer
effect: write
questions:
- Can I switch a restriction to apply only when the customer is the bill-to?
- How do I move a customer's assignment to another restriction group?
instructions:
- text: Set apply-when-bill-to to {applyWhenBillTo} on assignment {id}.
slots:
applyWhenBillTo: requestBody.applyWhenBillTo
id: path.id
- text: Move assignment {id} to restriction group {restrictionGroupId}.
slots:
id: path.id
restrictionGroupId: requestBody.restrictionGroupId
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/RestrictionGroupCustomers/Default.Default()'].get
update:
x-apievangelist-phrasing:
intent: Call the Default function on restriction assignments
effect: read
questions:
- What does the Default OData function on restriction group customers return?
- Is there a default restriction group customer entity to start from?
instructions:
- text: Call the Default function on restriction group customers.
- text: Get the default restriction group customer entity.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/restrictiongroupcustomers/delete'].delete
update:
x-apievangelist-phrasing:
intent: Bulk remove restriction group assignments
effect: destructive
questions:
- Can I remove many customers from restriction groups in a single call?
- How do I delete a list of restriction group assignments by ID?
instructions:
- text: Bulk delete restriction group assignments {ids}.
slots:
ids: query.ids
- text: 'Remove these customer restriction assignments: {ids}.'
slots:
ids: query.ids
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/admin/restrictiongroupcustomers({key})/customproperties({custompropertyKey})'].get
update:
x-apievangelist-phrasing:
intent: Get a custom property on a restriction assignment
effect: read
questions:
- How do I read a custom property stored on a restriction group assignment?
- Can restriction group customer records carry custom fields?
instructions:
- text: Get custom property {custompropertyKey} of restriction assignment {key}.
slots:
custompropertyKey: path.custompropertyKey
key: path.key
- text: Read custom field {custompropertyKey} on restriction group customer {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-restriction-group-customers-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.