Optimizely

Optimizely Website States API

The Website States API from Optimizely — 5 operation(s) for website states.

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/WebsiteStates List website state assignments · Returns the EntitySet WebsiteStates #
Ask an LLM
“Which states or provinces are enabled on each of my commerce websites?”
“Can I filter website states to one website?”
Tell an agent
List all website states.
List website states matching {filter}.
POST /api/v1/admin/WebsiteStates Enable a state on a website · Post a new entity to EntitySet WebsiteStates #
Ask an LLM
“How do I make a state or province available on a website?”
“Can I link a state to a specific commerce website?”
Tell an agent
Enable state {stateId} on website {websiteId}.
Assign state {stateId} to website {websiteId} as a new website state.
GET /api/v1/admin/WebsiteStates({id}) Get a website state assignment · Returns the entity with the key from WebsiteStates #
Ask an LLM
“Which website and state does one website state record link?”
“Can I fetch a single website state by ID?”
Tell an agent
Get website state {id}.
Show the website and state linked by record {id}.
PUT /api/v1/admin/WebsiteStates({id}) Replace a website state assignment · Replace entity in EntitySet WebsiteStates #
Ask an LLM
“How do I overwrite a website state record completely?”
“Does replacing a website state reset the fields I omit?”
Tell an agent
Replace website state {id} so it links website {websiteId} and state {stateId}.
Overwrite all fields of website state {id}.
DELETE /api/v1/admin/WebsiteStates({id}) Remove a state from a website · Delete entity in EntitySet WebsiteStates #
Ask an LLM
“Can I stop offering a state on a website by deleting its record?”
“Is it possible to delete a website state only if its ETag matches?”
Tell an agent destructive · confirm first
Delete website state {id}.
Delete website state {id} if its ETag is {etag}.
PATCH /api/v1/admin/WebsiteStates({id}) Update a website state assignment · Update entity in EntitySet WebsiteStates #
Ask an LLM
“How do I point an existing website state record at a different state?”
“Can I move a website state assignment to another website?”
Tell an agent
Change website state {id} to state {stateId}.
Move website state {id} to website {websiteId}.
GET /api/v1/admin/WebsiteStates/Default.Default() Get a blank website state template · Call operation Default #
Ask an LLM
“What default values does a new website state record have?”
“Can I fetch an empty website state template?”
Tell an agent
Fetch the default website state template.
Show the starting values for a new website state.
DELETE /api/v1/admin/websitestates/delete Bulk delete website states · Website states delete route #
Ask an LLM
“Can I remove several states from websites at once?”
“How do I bulk delete website state records by ID?”
Tell an agent destructive · confirm first
Bulk delete website states {ids}.
Remove these website state records together: {ids}.
GET /api/v1/admin/websitestates({key})/customproperties({custompropertyKey}) Get a custom property on a website state · Website states get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom property stored on a website state?”
“What extra custom values does a website state record carry?”
Tell an agent
Get custom property {custompropertyKey} on website state {key}.
Show website state {key}'s custom property {custompropertyKey}.

Specifications

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