Optimizely Translation Properties API

The Translation Properties API from Optimizely — 7 operation(s) for translation properties.

Operations 11

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/TranslationProperties List translated property values · Returns the EntitySet TranslationProperties #
Ask an LLM
“Which translated field values exist across my commerce data?”
“Can I filter translation properties by language or parent table?”
Tell an agent
List all translation properties.
List translation properties matching {filter}.
POST /api/v1/admin/TranslationProperties Add a translation for a property · Post a new entity to EntitySet TranslationProperties #
Ask an LLM
“How do I store a translated value for a field on a product or other record?”
“What do I need to supply to add a translation property - table, name and value?”
Tell an agent
Add a {languageId} translation of {name} on {parentTable} record {parentId}: {translatedValue}.
Create translation property {name} for table {parentTable} with value {translatedValue}.
GET /api/v1/admin/TranslationProperties({id}) Get one translation property · Returns the entity with the key from TranslationProperties #
Ask an LLM
“How do I look up a single translated value by its ID?”
“Can I select just certain fields of one translation property?”
Tell an agent
Get translation property {id}.
Show only {select} of translation property {id}.
PUT /api/v1/admin/TranslationProperties({id}) Replace a translation property · Replace entity in EntitySet TranslationProperties #
Ask an LLM
“How do I overwrite a translation property record completely?”
“Does replacing a translation require resending the table, name and value?”
Tell an agent
Replace translation property {id} with {name} on {parentTable} = {translatedValue}.
Fully overwrite translation record {id} for language {languageId}.
DELETE /api/v1/admin/TranslationProperties({id}) Delete a translation property · Delete entity in EntitySet TranslationProperties #
Ask an LLM
“How do I remove a translated value I no longer need?”
“Can I delete a translation only if nobody changed it since I read it?”
Tell an agent destructive · confirm first
Delete translation property {id}.
Delete translation {id} if its ETag is {ifMatch}.
PATCH /api/v1/admin/TranslationProperties({id}) Change a translated value · Update entity in EntitySet TranslationProperties #
Ask an LLM
“Can I just fix the wording of an existing translation?”
“How do I correct only the translated text without resending the rest?”
Tell an agent
Change translation {id} to read {translatedValue}.
Switch translation property {id} to language {languageId}.
GET /api/v1/admin/TranslationProperties/Default.Default() Call the Default function on translations · Call operation Default #
Ask an LLM
“What does the Default OData function on translation properties return?”
“Is there a default translation property template to start from?”
Tell an agent
Call the Default function on translation properties.
Get the default translation property entity.
GET /api/v1/admin/TranslationProperties/Default.forentity(entityName='{entityName}') Get translation properties for an entity type · Call operation forentity #
Ask an LLM
“Which translatable properties exist for a given entity like product or category?”
“Can I call the Default.forentity function to see translations for one entity type?”
Tell an agent
Call Default.forentity for entity {entityName}.
Get translation properties for the {entityName} entity via the Default namespace function.
GET /api/v1/admin/translationproperties/forentity(entityName='{entityName}') Get translations for an entity (short route) · Translation properties get for entity by entityname 2 #
Ask an LLM
“Is there a shorter forentity route without the Default prefix for entity translations?”
“Can I use the lowercase translationproperties/forentity path to list an entity's translations?”
Tell an agent
Use the short forentity route to list translations for {entityName}.
Get {entityName} translations from translationproperties/forentity.
DELETE /api/v1/admin/translationproperties/delete Bulk delete translation properties · Translation properties delete route #
Ask an LLM
“Can I delete many translation properties with one call?”
“How do I remove a batch of translations by their IDs?”
Tell an agent destructive · confirm first
Bulk delete translation properties {ids}.
Remove these translations in one go: {ids}.
GET /api/v1/admin/translationproperties({key})/customproperties({custompropertyKey}) Get a custom property on a translation · Translation properties get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property attached to a translation property record?”
“Can translation properties themselves carry custom fields?”
Tell an agent
Get custom property {custompropertyKey} of translation property {key}.
Read custom field {custompropertyKey} on translation record {key}.

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-translation-properties-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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optimizely-translation-properties-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Translation Properties API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Translation Properties
paths:
  /api/v1/admin/TranslationProperties:
    get:
      tags:
      - Translation Properties
      summary: Returns the EntitySet TranslationProperties
      operationId: TranslationProperties_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:
      - Translation Properties
      summary: Post a new entity to EntitySet TranslationProperties
      operationId: TranslationProperties_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.TranslationProperty'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/TranslationProperties({id}):
    get:
      tags:
      - Translation Properties
      summary: Returns the entity with the key from TranslationProperties
      operationId: TranslationProperties_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:
      - Translation Properties
      summary: Replace entity in EntitySet TranslationProperties
      operationId: TranslationProperties_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.TranslationProperty'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Translation Properties
      summary: Delete entity in EntitySet TranslationProperties
      operationId: TranslationProperties_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:
      - Translation Properties
      summary: Update entity in EntitySet TranslationProperties
      operationId: TranslationProperties_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.TranslationProperty'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/TranslationProperties/Default.Default():
    get:
      tags:
      - Translation Properties
      summary: Call operation Default
      operationId: TranslationProperties_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/TranslationProperties/Default.forentity(entityName='{entityName}'):
    get:
      tags:
      - Translation Properties
      summary: Call operation forentity
      operationId: TranslationProperties_GetForEntityByEntityname_1
      parameters:
      - name: entityName
        in: path
        description: 'parameter: entityName'
        required: true
        schema:
          type: string
      - 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: []
  /api/v1/admin/translationproperties/forentity(entityName='{entityName}'):
    get:
      tags:
      - Translation Properties
      operationId: TranslationProperties_GetForEntityByEntityname_2
      parameters:
      - name: entityName
        in: path
        required: true
        schema:
          type: string
      - 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: Translation properties get for entity by entityname 2
      x-summary-source: derived
  /api/v1/admin/translationproperties/delete:
    delete:
      tags:
      - Translation Properties
      operationId: TranslationProperties_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: Translation properties delete route
      x-summary-source: derived
  /api/v1/admin/translationproperties({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Translation Properties
      operationId: TranslationProperties_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: Translation properties get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.TranslationProperty:
      required:
      - parentTable
      - name
      - translatedValue
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        languageId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        parentTable:
          maxLength: 100
          minLength: 0
          type: string
        parentId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        name:
          maxLength: 50
          minLength: 0
          type: string
        translatedValue:
          maxLength: 2048
          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