Optimizely

Optimizely Property Configurations API

The Property Configurations API from Optimizely — 7 operation(s) for property configurations.

GitHub OpenAPI

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/PropertyConfigurations List property configurations · Returns the EntitySet PropertyConfigurations #
Ask an LLM
“Which field configurations are defined for admin entities?”
“Can I list only the custom properties flagged as PII?”
Tell an agent
List all property configurations.
Find property configurations matching {filter}.
POST /api/v1/admin/PropertyConfigurations Create a property configuration · Post a new entity to EntitySet PropertyConfigurations #
Ask an LLM
“How do I add a new custom field configuration to an entity?”
“Can I mark a new property as required, translatable or PII when I create it?”
Tell an agent
Create property configuration {name} labelled {label} on entity configuration {entityConfigurationId}.
Add a new custom property {name} with control type {controlType}.
GET /api/v1/admin/PropertyConfigurations({id}) Get a property configuration by ID · Returns the entity with the key from PropertyConfigurations #
Ask an LLM
“What control type and label does one property configuration use?”
“Is a specific property configuration set to sync to PIM?”
Tell an agent
Get property configuration {id}.
Show the settings of property configuration {id}.
PUT /api/v1/admin/PropertyConfigurations({id}) Replace a property configuration · Replace entity in EntitySet PropertyConfigurations #
Ask an LLM
“Can I overwrite an entire property configuration record at once?”
“What happens to omitted fields when I fully replace a property configuration?”
Tell an agent
Replace property configuration {id} with this full definition.
Overwrite property configuration {id} using a full PUT with label {label}.
DELETE /api/v1/admin/PropertyConfigurations({id}) Delete a property configuration by ID · Delete entity in EntitySet PropertyConfigurations #
Ask an LLM
“How do I delete one property configuration?”
“Does removing a property configuration honor an If-Match ETag?”
Tell an agent destructive · confirm first
Delete property configuration {id}.
Delete property configuration {id} only if its ETag matches {ifMatch}.
PATCH /api/v1/admin/PropertyConfigurations({id}) Update a property configuration · Update entity in EntitySet PropertyConfigurations #
Ask an LLM
“How do I change the hint text or tooltip of an existing property?”
“Can I make an existing property required without resending the whole record?”
Tell an agent
Set the tooltip of property configuration {id} to {toolTip}.
Mark property configuration {id} as required = {isRequired}.
GET /api/v1/admin/PropertyConfigurations/Default.Default() Get a default property configuration template · Call operation Default #
Ask an LLM
“What default values does a new property configuration start with?”
“Is there a blank property configuration template to fetch first?”
Tell an agent
Fetch the default property configuration template.
Show me the default values for a new property configuration.
DELETE /api/v1/admin/propertyconfigurations/delete Bulk delete property configurations · Property configurations delete route #
Ask an LLM
“How do I delete several property configurations at once?”
“Can I pass a list of IDs to remove many property configurations?”
Tell an agent destructive · confirm first
Bulk delete the property configurations with IDs {ids}.
Remove all of these property configurations in one call: {ids}.
GET /api/v1/admin/propertyconfigurations({key})/customproperties({custompropertyKey}) Get a custom property on a property configuration · Property configurations get custom property by key and custompropertykey #
Ask an LLM
“Where do I read a custom property value attached to a property configuration?”
“Can I fetch one extra property from a property configuration record?”
Tell an agent
Get custom property {custompropertyKey} on property configuration {key}.
Show the custom property {custompropertyKey} of property configuration {key}.
GET /api/v1/admin/propertyconfigurations({key})/propertyattributeconfigurations({propertyattributeconfigurationKey}) Get an attribute configuration of a property · Property configurations get property attribute configuration by key and… #
Ask an LLM
“What attribute settings are attached to a property configuration?”
“Can I look up one property attribute configuration under a property?”
Tell an agent
Get attribute configuration {propertyattributeconfigurationKey} of property configuration {key}.
Show property attribute configuration {propertyattributeconfigurationKey} under property {key}.
GET /api/v1/admin/propertyconfigurations({key})/propertypermissions({propertypermissionKey}) Get a permission rule on a property · Property configurations get property permission by key and propertypermissionkey #
Ask an LLM
“Who can view or edit a given property configuration?”
“Can I fetch a single property permission entry by its key?”
Tell an agent
Get property permission {propertypermissionKey} on property configuration {key}.
Show the view and edit permission {propertypermissionKey} for property {key}.

Specifications

⚙
OpenAPI
https://artifacts.apis.io/optimizely/openapi/optimizely-property-configurations-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-property-configurations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-property-configurations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Property Configurations API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Property Configurations
paths:
  /api/v1/admin/PropertyConfigurations:
    get:
      tags:
      - Property Configurations
      summary: Returns the EntitySet PropertyConfigurations
      operationId: PropertyConfigurations_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:
      - Property Configurations
      summary: Post a new entity to EntitySet PropertyConfigurations
      operationId: PropertyConfigurations_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.PropertyConfiguration'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PropertyConfigurations({id}):
    get:
      tags:
      - Property Configurations
      summary: Returns the entity with the key from PropertyConfigurations
      operationId: PropertyConfigurations_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:
      - Property Configurations
      summary: Replace entity in EntitySet PropertyConfigurations
      operationId: PropertyConfigurations_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.PropertyConfiguration'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Property Configurations
      summary: Delete entity in EntitySet PropertyConfigurations
      operationId: PropertyConfigurations_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:
      - Property Configurations
      summary: Update entity in EntitySet PropertyConfigurations
      operationId: PropertyConfigurations_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.PropertyConfiguration'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PropertyConfigurations/Default.Default():
    get:
      tags:
      - Property Configurations
      summary: Call operation Default
      operationId: PropertyConfigurations_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/propertyconfigurations/delete:
    delete:
      tags:
      - Property Configurations
      operationId: PropertyConfigurations_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: Property configurations delete route
      x-summary-source: derived
  /api/v1/admin/propertyconfigurations({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Property Configurations
      operationId: PropertyConfigurations_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: Property configurations get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/propertyconfigurations({key})/propertyattributeconfigurations({propertyattributeconfigurationKey}):
    get:
      tags:
      - Property Configurations
      operationId: PropertyConfigurations_GetPropertyAttributeConfigurationByKeyAndPropertyattributeconfigurationkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: propertyattributeconfigurationKey
        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: Property configurations get property attribute configuration by key and…
      x-summary-source: derived
  /api/v1/admin/propertyconfigurations({key})/propertypermissions({propertypermissionKey}):
    get:
      tags:
      - Property Configurations
      operationId: PropertyConfigurations_GetPropertyPermissionByKeyAndPropertypermissionkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: propertypermissionKey
        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: Property configurations get property permission by key and propertypermissionkey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.PropertyConfiguration:
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        controlType:
          maxLength: 2048
          minLength: 0
          type: string
        propertyType:
          maxLength: 2048
          minLength: 0
          type: string
        entityConfigurationId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        hintText:
          maxLength: 2048
          minLength: 0
          type: string
        isRequired:
          type: boolean
        isTranslatable:
          type: boolean
        isCustomProperty:
          type: boolean
        label:
          maxLength: 256
          minLength: 0
          type: string
        name:
          maxLength: 256
          minLength: 0
          type: string
        parentProperty:
          maxLength: 256
          minLength: 0
          type: string
        hintTextPropertyName:
          maxLength: 256
          minLength: 0
          type: string
        canView:
          type: boolean
        canEdit:
          type: boolean
        toolTip:
          maxLength: 256
          minLength: 0
          type: string
        syncToPim:
          type: boolean
        isPii:
          type: boolean
        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