Optimizely

Optimizely Badges API

The Badges API from Optimizely — 7 operation(s) for badges.

GitHub OpenAPI

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/admin/Badges List product badges · Returns the EntitySet Badges #
Ask an LLM
“How do I list all the product badges set up in my commerce admin?”
“Can I filter badges by name or sort them by sort order?”
Tell an agent
List all product badges.
Find badges matching the filter {filter}.
POST /api/v1/admin/Badges Create a product badge · Post a new entity to EntitySet Badges #
Ask an LLM
“How do I create a new badge like 'Sale' or 'New' for products?”
“Can I schedule a badge to activate and deactivate on set dates?”
Tell an agent
Create a badge named {name} that displays {displayText}.
Create badge {name} active from {activateOn} to {deactivateOn}.
GET /api/v1/admin/Badges({id}) Get a product badge · Returns the entity with the key from Badges #
Ask an LLM
“How do I look up one badge's settings by its ID?”
“What colors and display text does a specific badge use?”
Tell an agent
Get badge {id}.
Show the configuration of badge {id}.
PUT /api/v1/admin/Badges({id}) Replace a product badge · Replace entity in EntitySet Badges #
Ask an LLM
“How do I overwrite a badge record with a full new definition?”
“Does replacing a badge reset fields I leave out?”
Tell an agent
Replace badge {id} with a full definition named {name}.
Overwrite every field of badge {id}, setting display text {displayText}.
DELETE /api/v1/admin/Badges({id}) Delete a product badge · Delete entity in EntitySet Badges #
Ask an LLM
“How do I delete one badge by its ID?”
“Can I guard a badge deletion with an ETag match?”
Tell an agent destructive · confirm first
Delete badge {id}.
Delete badge {id} only if its ETag is {etag}.
PATCH /api/v1/admin/Badges({id}) Update a product badge · Update entity in EntitySet Badges #
Ask an LLM
“How do I change just the color of an existing badge?”
“Can I update a badge's display text without resending all its fields?”
Tell an agent
Change the badge color of badge {id} to {badgeColorHexCode}.
Update the display text on badge {id} to {displayText}.
GET /api/v1/admin/Badges/Default.Default() Get a default badge template · Call operation Default #
Ask an LLM
“What default values does a new badge start with?”
“Can I fetch a blank badge template before creating one?”
Tell an agent
Fetch the default badge template.
Show me the default values for a new badge.
DELETE /api/v1/admin/badges/delete Bulk delete product badges · Badges delete route #
Ask an LLM
“How do I delete several badges at once?”
“Can I remove a batch of badges by passing a list of IDs?”
Tell an agent destructive · confirm first
Bulk delete the badges with IDs {ids}.
Remove all of these badges in one call: {ids}.
GET /api/v1/admin/badges({key})/attributevalues({attributevalueKey}) Get an attribute value tied to a badge · Badges get attribute value by key and attributevaluekey #
Ask an LLM
“Which attribute values is a badge linked to?”
“Can I look up one attribute value on a badge?”
Tell an agent
Get attribute value {attributevalueKey} on badge {key}.
Show badge {key}'s linked attribute value {attributevalueKey}.
GET /api/v1/admin/badges({key})/customproperties({custompropertyKey}) Get a custom property on a badge · Badges get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property stored on a badge?”
“Can I fetch one extra property value from a badge record?”
Tell an agent
Get custom property {custompropertyKey} on badge {key}.
Show the custom property {custompropertyKey} of badge {key}.
GET /api/v1/admin/badges({key})/products({productKey}) Get a product assigned to a badge · Badges get product by key and productkey #
Ask an LLM
“Is a particular product assigned to a badge?”
“Can I look up one product linked to a badge?”
Tell an agent
Get product {productKey} under badge {key}.
Check whether badge {key} includes product {productKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-badges-api-openapi.yml

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/optimizely:optimizely-badges-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

OpenAPI Specification

optimizely-badges-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Badges API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Badges
paths:
  /api/v1/admin/Badges:
    get:
      tags:
      - Badges
      summary: Returns the EntitySet Badges
      operationId: Badges_Get
      parameters:
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: Filters the results, based on a Boolean condition.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      - name: $apply
        in: query
        description: Aggregates the results according to one or more transformations.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results.
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: Returns only the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $skip
        in: query
        description: Skips the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $count
        in: query
        description: Includes a count of the matching results in the response.
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    post:
      tags:
      - Badges
      summary: Post a new entity to EntitySet Badges
      operationId: Badges_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.Badge'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/Badges({id}):
    get:
      tags:
      - Badges
      summary: Returns the entity with the key from Badges
      operationId: Badges_GetById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    put:
      tags:
      - Badges
      summary: Replace entity in EntitySet Badges
      operationId: Badges_PutById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.Badge'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Badges
      summary: Delete entity in EntitySet Badges
      operationId: Badges_DeleteById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: If-Match
        in: header
        description: If-Match header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    patch:
      tags:
      - Badges
      summary: Update entity in EntitySet Badges
      operationId: Badges_PatchById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.Badge'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/Badges/Default.Default():
    get:
      tags:
      - Badges
      summary: Call operation Default
      operationId: Badges_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/badges/delete:
    delete:
      tags:
      - Badges
      operationId: Badges_DeleteRoute
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Badges delete route
      x-summary-source: derived
  /api/v1/admin/badges({key})/attributevalues({attributevalueKey}):
    get:
      tags:
      - Badges
      operationId: Badges_GetAttributeValueByKeyAndAttributevaluekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: attributevalueKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Badges get attribute value by key and attributevaluekey
      x-summary-source: derived
  /api/v1/admin/badges({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Badges
      operationId: Badges_GetCustomPropertyByKeyAndCustompropertykey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: custompropertyKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Badges get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/badges({key})/products({productKey}):
    get:
      tags:
      - Badges
      operationId: Badges_GetProductByKeyAndProductkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: productKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Badges get product by key and productkey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.Badge:
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        name:
          maxLength: 255
          minLength: 0
          type: string
        tagName:
          maxLength: 1024
          minLength: 0
          type: string
        sortOrder:
          format: int32
          type: integer
        activateOn:
          format: date-time
          type: string
        deactivateOn:
          format: date-time
          type: string
        displayOnProductImages:
          type: boolean
        displayOnBadgeWidget:
          type: boolean
        ruleManagerId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        badgeType:
          maxLength: 50
          minLength: 0
          type: string
        displayText:
          maxLength: 512
          minLength: 0
          type: string
        textColorHexCode:
          maxLength: 6
          minLength: 0
          type: string
        badgeColorHexCode:
          maxLength: 6
          minLength: 0
          type: string
        largeImageBadgePath:
          maxLength: 1024
          minLength: 0
          type: string
        largeImageTextSize:
          maxLength: 50
          minLength: 0
          type: string
        otherImageBadgePath:
          maxLength: 1024
          minLength: 0
          type: string
        otherImageTextSize:
          maxLength: 50
          minLength: 0
          type: string
        imageAltText:
          maxLength: 1024
          minLength: 0
          type: string
        detailWidgetBadgeSize:
          maxLength: 50
          minLength: 0
          type: string
        badgeStyle:
          maxLength: 50
          minLength: 0
          type: string
        largeImagePlacement:
          maxLength: 50
          minLength: 0
          type: string
        otherImagePlacement:
          maxLength: 50
          minLength: 0
          type: string
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query