Optimizely

Optimizely Global Synonyms API

The Global Synonyms API from Optimizely — 5 operation(s) for global synonyms.

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/GlobalSynonyms List search synonyms · Returns the EntitySet GlobalSynonyms #
Ask an LLM
“How do I see all the global search synonyms configured in Optimizely Configured Commerce?”
“Can I filter synonyms by language or synonym type?”
Tell an agent
List all global search synonyms.
List global synonyms matching {filter}.
POST /api/v1/admin/GlobalSynonyms Add a search synonym · Post a new entity to EntitySet GlobalSynonyms #
Ask an LLM
“How can I make searches for one word also match another term?”
“Can I add a synonym for a specific language?”
Tell an agent
Create a {synonymType} synonym mapping {lookupValue} to {mappedValue}.
Add synonym {lookupValue} -> {mappedValue} in language {languageId}, described as {description}.
GET /api/v1/admin/GlobalSynonyms({id}) Get one search synonym · Returns the entity with the key from GlobalSynonyms #
Ask an LLM
“What does a particular synonym map its lookup term to?”
“Can I select only some fields of one synonym record?”
Tell an agent
Show global synonym {id}.
Get global synonym {id} returning {select}.
PUT /api/v1/admin/GlobalSynonyms({id}) Replace a search synonym · Replace entity in EntitySet GlobalSynonyms #
Ask an LLM
“Can I overwrite a synonym with a new lookup and mapped value?”
“What's needed to replace an entire synonym record?”
Tell an agent
Replace synonym {id} so {lookupValue} maps to {mappedValue}.
Overwrite synonym record {id} entirely with type {synonymType}.
DELETE /api/v1/admin/GlobalSynonyms({id}) Delete a search synonym · Delete entity in EntitySet GlobalSynonyms #
Ask an LLM
“How do I stop a synonym from affecting search by deleting it?”
“Can I delete a synonym conditionally on its ETag?”
Tell an agent destructive · confirm first
Delete global synonym {id}.
Delete synonym {id} if its ETag is {etag}.
PATCH /api/v1/admin/GlobalSynonyms({id}) Update a search synonym · Update entity in EntitySet GlobalSynonyms #
Ask an LLM
“Can I change only the mapped term of an existing synonym?”
“How do I edit a synonym's description without touching the rest?”
Tell an agent
Patch synonym {id} to map to {mappedValue}.
Update synonym {id} description to {description}.
GET /api/v1/admin/GlobalSynonyms/Default.Default() Get default values for a synonym · Call operation Default #
Ask an LLM
“What defaults are pre-filled for a new global synonym?”
“Is there a blank synonym template?”
Tell an agent
Get the default global synonym template.
Show pre-filled values for a new search synonym.
DELETE /api/v1/admin/globalsynonyms/delete Delete several search synonyms · Global synonyms delete route #
Ask an LLM
“Can I bulk delete a list of synonyms?”
“How do I clear out many search synonyms in one call?”
Tell an agent destructive · confirm first
Bulk delete global synonyms {ids}.
Remove every synonym listed in {ids}.
GET /api/v1/admin/globalsynonyms({key})/customproperties({custompropertyKey}) Get a custom property on a synonym · Global synonyms get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom property attached to a search synonym?”
“Where are custom attributes on a synonym stored?”
Tell an agent
Get custom property {custompropertyKey} on global synonym {key}.
Show synonym {key}'s custom property {custompropertyKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-global-synonyms-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-global-synonyms-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-global-synonyms-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Global Synonyms API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Global Synonyms
paths:
  /api/v1/admin/GlobalSynonyms:
    get:
      tags:
      - Global Synonyms
      summary: Returns the EntitySet GlobalSynonyms
      operationId: GlobalSynonyms_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:
      - Global Synonyms
      summary: Post a new entity to EntitySet GlobalSynonyms
      operationId: GlobalSynonyms_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.GlobalSynonym'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/GlobalSynonyms({id}):
    get:
      tags:
      - Global Synonyms
      summary: Returns the entity with the key from GlobalSynonyms
      operationId: GlobalSynonyms_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:
      - Global Synonyms
      summary: Replace entity in EntitySet GlobalSynonyms
      operationId: GlobalSynonyms_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.GlobalSynonym'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Global Synonyms
      summary: Delete entity in EntitySet GlobalSynonyms
      operationId: GlobalSynonyms_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:
      - Global Synonyms
      summary: Update entity in EntitySet GlobalSynonyms
      operationId: GlobalSynonyms_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.GlobalSynonym'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/GlobalSynonyms/Default.Default():
    get:
      tags:
      - Global Synonyms
      summary: Call operation Default
      operationId: GlobalSynonyms_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/globalsynonyms/delete:
    delete:
      tags:
      - Global Synonyms
      operationId: GlobalSynonyms_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: Global synonyms delete route
      x-summary-source: derived
  /api/v1/admin/globalsynonyms({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Global Synonyms
      operationId: GlobalSynonyms_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: Global synonyms get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.GlobalSynonym:
      required:
      - synonymType
      - lookupValue
      - mappedValue
      - description
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        synonymType:
          maxLength: 50
          minLength: 0
          type: string
        lookupValue:
          maxLength: 50
          minLength: 0
          type: string
        mappedValue:
          maxLength: 50
          minLength: 0
          type: string
        description:
          maxLength: 100
          minLength: 0
          type: string
        parentId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        languageId:
          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