Optimizely

Optimizely Website Promotions API

The Website Promotions API from Optimizely — 5 operation(s) for website promotions.

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/WebsitePromotions List website-promotion assignments · Returns the EntitySet WebsitePromotions #
Ask an LLM
“Which promotions are running on which websites?”
“Can I filter website promotions to one site?”
Tell an agent
List all website-promotion assignments.
Find website promotions matching {filter}.
POST /api/v1/admin/WebsitePromotions Run a promotion on a website · Post a new entity to EntitySet WebsitePromotions #
Ask an LLM
“How do I make a promotion available on a specific website?”
“Can I assign a promotion to a storefront site?”
Tell an agent
Assign promotion {promotionId} to website {websiteId}.
Enable promotion {promotionId} on site {websiteId}.
GET /api/v1/admin/WebsitePromotions({id}) Get a website-promotion assignment · Returns the entity with the key from WebsitePromotions #
Ask an LLM
“Can I look up one website-promotion link by ID?”
“Which website and promotion does an assignment connect?”
Tell an agent
Show website-promotion assignment {id}.
Get the site and promotion for link {id}.
PUT /api/v1/admin/WebsitePromotions({id}) Replace a website-promotion assignment · Replace entity in EntitySet WebsitePromotions #
Ask an LLM
“How do I overwrite a website-promotion link entirely?”
“Can I replace an assignment with a different site and promotion?”
Tell an agent
Replace assignment {id} with website {websiteId} and promotion {promotionId}.
Overwrite website-promotion link {id} in full.
DELETE /api/v1/admin/WebsitePromotions({id}) Remove a promotion from a website · Delete entity in EntitySet WebsitePromotions #
Ask an LLM
“How do I stop a promotion running on a website?”
“Can I delete a website-promotion link with an ETag check?”
Tell an agent destructive · confirm first
Delete website-promotion assignment {id}.
Remove link {id} only if its ETag is {etag}.
PATCH /api/v1/admin/WebsitePromotions({id}) Change a website-promotion assignment · Update entity in EntitySet WebsitePromotions #
Ask an LLM
“Can I move a promotion assignment to a different website?”
“How do I swap the promotion on an existing website link?”
Tell an agent
Move assignment {id} to website {websiteId}.
Change the promotion on link {id} to {promotionId}.
GET /api/v1/admin/WebsitePromotions/Default.Default() Get default values for a new website promotion · Call operation Default #
Ask an LLM
“What defaults does a new website-promotion assignment start with?”
“Is there an empty template for a website-promotion link?”
Tell an agent
Get the default website-promotion template.
Show prefilled defaults for a new website-promotion link.
DELETE /api/v1/admin/websitepromotions/delete Bulk remove website-promotion assignments · Website promotions delete route #
Ask an LLM
“Can I delete many website-promotion links in one call?”
“How do I bulk pull promotions off websites by ID?”
Tell an agent destructive · confirm first
Bulk delete website-promotion assignments {ids}.
Remove the website-promotion links with IDs {ids}.
GET /api/v1/admin/websitepromotions({key})/customproperties({custompropertyKey}) Get a custom property on a website promotion · Website promotions get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom property on a website-promotion assignment?”
“Where do extra fields for a website-promotion link live?”
Tell an agent
Show custom property {property} on website-promotion link {key}.
Get assignment {key}'s custom field {property}.

Specifications

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