Optimizely

Optimizely Badge Products API

The Badge Products API from Optimizely — 5 operation(s) for badge products.

GitHub OpenAPI

Operations 9

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/BadgeProducts List badge-to-product assignments · Returns the EntitySet BadgeProducts #
Ask an LLM
“How do I see which products have which badges assigned?”
“Can I filter badge assignments to only the manually assigned ones?”
Tell an agent
List badge product assignments matching {filter}.
Show the first {top} badge assignments.
POST /api/v1/admin/BadgeProducts Assign a badge to a product · Post a new entity to EntitySet BadgeProducts #
Ask an LLM
“Can I put a badge like 'New' on a product through the admin API?”
“Is there a flag to record that a badge was assigned manually?”
Tell an agent
Assign badge {badgeId} to product {productId}.
Manually attach badge {badgeId} to product {productId} with manual flag {manuallyAssigned}.
GET /api/v1/admin/BadgeProducts({id}) Get one badge assignment · Returns the entity with the key from BadgeProducts #
Ask an LLM
“Where do I look up a single badge-product assignment by its id?”
“Which badge and product does a given assignment record link?”
Tell an agent
Get badge assignment {id}.
Show the badge and product on assignment record {id}.
PUT /api/v1/admin/BadgeProducts({id}) Replace a badge assignment · Replace entity in EntitySet BadgeProducts #
Ask an LLM
“How do I fully overwrite a badge-product assignment record?”
“Can I swap the whole assignment to a different badge and product in one replace?”
Tell an agent
Replace badge assignment {id} with badge {badgeId} on product {productId}.
Overwrite the entire badge assignment record {id}.
DELETE /api/v1/admin/BadgeProducts({id}) Remove a badge from a product · Delete entity in EntitySet BadgeProducts #
Ask an LLM
“Can I take a badge off a product by deleting its assignment?”
“Is an If-Match ETag supported when removing a badge assignment?”
Tell an agent destructive · confirm first
Delete badge assignment {id}.
Remove badge assignment {id} only if ETag {etag} matches.
PATCH /api/v1/admin/BadgeProducts({id}) Update fields on a badge assignment · Update entity in EntitySet BadgeProducts #
Ask an LLM
“Can I change just the manual-assignment flag on an existing badge assignment?”
“How do I point an existing assignment at a different badge without replacing it?”
Tell an agent
Set the manually assigned flag on badge assignment {id} to {manuallyAssigned}.
Change assignment {id} to use badge {badgeId}.
GET /api/v1/admin/BadgeProducts/Default.Default() Call the Default function on badge products · Call operation Default #
Ask an LLM
“What does the Default function on the BadgeProducts set return?”
“Where do I get the default badge product entity?”
Tell an agent
Call the Default function on BadgeProducts.
Fetch the default badge product entity.
DELETE /api/v1/admin/badgeproducts/delete Bulk remove badge assignments · Badge products delete route #
Ask an LLM
“Can I remove many badge assignments at once by id?”
“Is there a bulk way to strip badges from a batch of products?”
Tell an agent destructive · confirm first
Bulk delete badge assignments {ids}.
Remove every badge assignment in the id list {ids}.
GET /api/v1/admin/badgeproducts({key})/customproperties({custompropertyKey}) Get a custom property on a badge assignment · Badge products get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property stored on a badge assignment?”
“Can I fetch one extension field value from a badge-product record?”
Tell an agent
Get custom property {custompropertyKey} of badge assignment {key}.
Show custom field {custompropertyKey} on badge product {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-badge-products-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-badge-products-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-badge-products-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Badge Products API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Badge Products
paths:
  /api/v1/admin/BadgeProducts:
    get:
      tags:
      - Badge Products
      summary: Returns the EntitySet BadgeProducts
      operationId: BadgeProducts_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:
      - Badge Products
      summary: Post a new entity to EntitySet BadgeProducts
      operationId: BadgeProducts_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.BadgeProduct'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/BadgeProducts({id}):
    get:
      tags:
      - Badge Products
      summary: Returns the entity with the key from BadgeProducts
      operationId: BadgeProducts_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:
      - Badge Products
      summary: Replace entity in EntitySet BadgeProducts
      operationId: BadgeProducts_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.BadgeProduct'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Badge Products
      summary: Delete entity in EntitySet BadgeProducts
      operationId: BadgeProducts_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:
      - Badge Products
      summary: Update entity in EntitySet BadgeProducts
      operationId: BadgeProducts_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.BadgeProduct'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/BadgeProducts/Default.Default():
    get:
      tags:
      - Badge Products
      summary: Call operation Default
      operationId: BadgeProducts_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/badgeproducts/delete:
    delete:
      tags:
      - Badge Products
      operationId: BadgeProducts_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: Badge products delete route
      x-summary-source: derived
  /api/v1/admin/badgeproducts({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Badge Products
      operationId: BadgeProducts_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: Badge products get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.BadgeProduct:
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        badgeId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        productId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        manuallyAssigned:
          type: boolean
        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