Optimizely

Optimizely Rule Types API

The Rule Types API from Optimizely — 6 operation(s) for rule types.

GitHub OpenAPI

Operations 10

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/RuleTypes List rule types · Returns the EntitySet RuleTypes #
Ask an LLM
“Which rule types are available for building promotion and pricing rules?”
“Can I sort or filter the list of rule types by name?”
Tell an agent
List all rule types.
Find rule types matching {filter}.
POST /api/v1/admin/RuleTypes Create a rule type · Post a new entity to EntitySet RuleTypes #
Ask an LLM
“How do I add a new rule type?”
“Is a name the only required field for a new rule type?”
Tell an agent
Create a rule type named {name}.
Add rule type {name} to the admin.
GET /api/v1/admin/RuleTypes({id}) Get a rule type · Returns the entity with the key from RuleTypes #
Ask an LLM
“Can I look up one rule type by its ID?”
“What does a single rule type record hold?”
Tell an agent
Show rule type {id}.
Get rule type {id} with {expand} expanded.
PUT /api/v1/admin/RuleTypes({id}) Replace a rule type · Replace entity in EntitySet RuleTypes #
Ask an LLM
“How do I overwrite a rule type record in full?”
“Does replacing a rule type mean resending its name?”
Tell an agent
Replace rule type {id} with name {name}.
Overwrite the whole record of rule type {id}.
DELETE /api/v1/admin/RuleTypes({id}) Delete a rule type · Delete entity in EntitySet RuleTypes #
Ask an LLM
“How do I permanently delete one rule type?”
“Can a rule type delete be guarded by an ETag?”
Tell an agent destructive · confirm first
Delete rule type {id}.
Delete rule type {id} if its ETag is {etag}.
PATCH /api/v1/admin/RuleTypes({id}) Rename a rule type · Update entity in EntitySet RuleTypes #
Ask an LLM
“Can I change just the name of an existing rule type?”
“What's the way to partially update a rule type?”
Tell an agent
Rename rule type {id} to {name}.
Patch rule type {id} with a new name {name}.
GET /api/v1/admin/RuleTypes/Default.Default() Get default values for a new rule type · Call operation Default #
Ask an LLM
“What defaults does a new rule type start with?”
“Is there a blank rule type template?”
Tell an agent
Get the default rule type template.
Show prefilled defaults for a new rule type.
DELETE /api/v1/admin/ruletypes/delete Bulk delete rule types · Rule types delete route #
Ask an LLM
“Can I delete several rule types at once by ID?”
“How do I bulk remove unused rule types?”
Tell an agent destructive · confirm first
Bulk delete rule types {ids}.
Permanently remove the rule types with IDs {ids}.
GET /api/v1/admin/ruletypes({key})/customproperties({custompropertyKey}) Get a custom property on a rule type · Rule types get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom property stored on a rule type?”
“Where are extra custom fields for a rule type kept?”
Tell an agent
Show custom property {property} on rule type {key}.
Get rule type {key}'s custom field {property}.
GET /api/v1/admin/ruletypes({key})/ruletypeoptions({ruletypeoptionKey}) Get an option of a rule type · Rule types get rule type option by key and ruletypeoptionkey #
Ask an LLM
“What options does a rule type offer, and can I read one of them?”
“Can I look up a single rule type option?”
Tell an agent
Show option {option} of rule type {key}.
Get rule type option {option} under rule type {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-rule-types-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-rule-types-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-rule-types-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Rule Types API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Rule Types
paths:
  /api/v1/admin/RuleTypes:
    get:
      tags:
      - Rule Types
      summary: Returns the EntitySet RuleTypes
      operationId: RuleTypes_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:
      - Rule Types
      summary: Post a new entity to EntitySet RuleTypes
      operationId: RuleTypes_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.RuleType'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/RuleTypes({id}):
    get:
      tags:
      - Rule Types
      summary: Returns the entity with the key from RuleTypes
      operationId: RuleTypes_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:
      - Rule Types
      summary: Replace entity in EntitySet RuleTypes
      operationId: RuleTypes_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.RuleType'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Rule Types
      summary: Delete entity in EntitySet RuleTypes
      operationId: RuleTypes_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:
      - Rule Types
      summary: Update entity in EntitySet RuleTypes
      operationId: RuleTypes_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.RuleType'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/RuleTypes/Default.Default():
    get:
      tags:
      - Rule Types
      summary: Call operation Default
      operationId: RuleTypes_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ruletypes/delete:
    delete:
      tags:
      - Rule Types
      operationId: RuleTypes_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: Rule types delete route
      x-summary-source: derived
  /api/v1/admin/ruletypes({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Rule Types
      operationId: RuleTypes_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: Rule types get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/ruletypes({key})/ruletypeoptions({ruletypeoptionKey}):
    get:
      tags:
      - Rule Types
      operationId: RuleTypes_GetRuleTypeOptionByKeyAndRuletypeoptionkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: ruletypeoptionKey
        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: Rule types get rule type option by key and ruletypeoptionkey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.RuleType:
      required:
      - name
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        name:
          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