Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Badge Attribute Values API

10 actions 10 updates phrasing extends openapi/optimizely-badge-attribute-values-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/api/v1/admin/BadgeAttributeValues'].get
$.paths['/api/v1/admin/BadgeAttributeValues'].post
$.paths['/api/v1/admin/BadgeAttributeValues({id})'].get
$.paths['/api/v1/admin/BadgeAttributeValues({id})'].put
$.paths['/api/v1/admin/BadgeAttributeValues({id})'].delete
$.paths['/api/v1/admin/BadgeAttributeValues({id})'].patch
$.paths['/api/v1/admin/BadgeAttributeValues/Default.Default()'].get
$.paths['/api/v1/admin/badgeattributevalues/delete'].delete
$.paths['/api/v1/admin/badgeattributevalues({key})/customproperties({custompropertyKey})'].get

OpenAPI Overlay

Raw ↑ 
# 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 Badge Attribute Values API
  version: 1.0.0
extends: openapi/optimizely-badge-attribute-values-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/BadgeAttributeValues'].get
  update:
    x-apievangelist-phrasing:
      intent: List badge attribute value links
      effect: read
      questions:
      - Which attribute values are tied to product badges in Optimizely Configured Commerce?
      - Can I filter badge attribute values down to one badge?
      instructions:
      - text: List all badge attribute value links.
      - text: List badge attribute values matching {filter}, top {top}.
        slots:
          filter: query.$filter
          top: query.$top
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/BadgeAttributeValues'].post
  update:
    x-apievangelist-phrasing:
      intent: Link an attribute value to a badge
      effect: write
      questions:
      - How do I make a badge apply to products with a certain attribute value?
      - What do I need to connect a badge to an attribute value?
      instructions:
      - text: Link badge {badgeId} to attribute value {attributeValueId}.
        slots:
          badgeId: requestBody.badgeId
          attributeValueId: requestBody.attributeValueId
      - text: Attach attribute value {attributeValueId} as a rule for badge {badgeId}.
        slots:
          attributeValueId: requestBody.attributeValueId
          badgeId: requestBody.badgeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/BadgeAttributeValues({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one badge attribute value link
      effect: read
      questions:
      - How do I look up a single badge-to-attribute-value link by its ID?
      - Can I expand the badge on one badge attribute value record?
      instructions:
      - text: Show badge attribute value {id}.
        slots:
          id: path.id
      - text: Fetch badge attribute value {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/BadgeAttributeValues({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a badge attribute value link
      effect: write
      questions:
      - Can I overwrite a badge attribute value link with a new badge and value?
      - What happens when I fully replace a badge attribute value record?
      instructions:
      - text: Replace badge attribute value {id} with badge {badgeId} and attribute value {attributeValueId}.
        slots:
          id: path.id
          badgeId: requestBody.badgeId
          attributeValueId: requestBody.attributeValueId
      - text: Overwrite the whole badge attribute value record {id}, pointing it at badge {badgeId}.
        slots:
          id: path.id
          badgeId: requestBody.badgeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/BadgeAttributeValues({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a badge attribute value link
      effect: destructive
      questions:
      - How do I unlink one attribute value from a badge?
      - Can I make removing a badge attribute value conditional on an ETag?
      instructions:
      - text: Delete badge attribute value {id}.
        slots:
          id: path.id
      - text: Delete badge attribute value {id} only if its ETag matches {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/BadgeAttributeValues({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a badge attribute value link
      effect: write
      questions:
      - Can I switch just the attribute value on an existing badge link?
      - Is it possible to partially update a badge attribute value?
      instructions:
      - text: Patch badge attribute value {id} to use attribute value {attributeValueId}.
        slots:
          id: path.id
          attributeValueId: requestBody.attributeValueId
      - text: Move badge attribute value {id} over to badge {badgeId}.
        slots:
          id: path.id
          badgeId: requestBody.badgeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/BadgeAttributeValues/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a badge attribute value
      effect: read
      questions:
      - What defaults does the admin pre-fill for a new badge attribute value?
      - Where can I get a blank badge attribute value template?
      instructions:
      - text: Get the default badge attribute value template.
      - text: Show me the pre-filled defaults for a new badge attribute value.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/badgeattributevalues/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete badge attribute values
      effect: destructive
      questions:
      - How do I unlink many attribute values from badges in one request?
      - Can I bulk-remove badge attribute values by ID?
      instructions:
      - text: Bulk delete badge attribute values {ids}.
        slots:
          ids: query.ids
      - text: Permanently remove the badge attribute value links {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/badgeattributevalues({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a badge attribute value
      effect: read
      questions:
      - How can I read one custom property on a badge attribute value?
      - Can I select fields from a badge attribute value's custom property?
      instructions:
      - text: Show custom property {custompropertyKey} on badge attribute value {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Fetch badge attribute value {key}'s custom property {custompropertyKey}, selecting {select}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
          select: query.$select
      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.
All 92 tools →

Call it yourself

curl for this page
This overlay 
curl "https://apis.io/api/v1/overlays/optimizely-badge-attribute-values-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.