Optimizely Content Item Fields API

The Content Item Fields API from Optimizely — 5 operation(s) for content item fields.

Documentation 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/ContentItemFields List CMS content item fields · Returns the EntitySet ContentItemFields #

Ask an LLM

“How can I see all the content item fields stored for my site's CMS content?”

“Can I filter content item fields by field name or language?”

Tell an agent

List all content item fields.

List content item fields matching {filter}.

POST /api/v1/admin/ContentItemFields Create a content item field · Post a new entity to EntitySet ContentItemFields #

Ask an LLM

“How do I add a new field value to a content item?”

“What does a content item field need, such as device type and field type?”

Tell an agent

Create content field {fieldName} of type {fieldType} for device {deviceType}.

Add field {fieldName} ({fieldType}, device {deviceType}) to content {contentKey} with text {stringValue}.

GET /api/v1/admin/ContentItemFields({id}) Get one content item field · Returns the entity with the key from ContentItemFields #

Ask an LLM

“How can I read a single content item field by its id?”

“Can I see when one content field was approved or published?”

Tell an agent

Show content item field {id}.

Fetch {select} for content item field {id}.

PUT /api/v1/admin/ContentItemFields({id}) Replace a content item field · Replace entity in EntitySet ContentItemFields #

Ask an LLM

“How do I overwrite every property of a content item field?”

“Does a full replace of a content field wipe values I don't include?”

Tell an agent

Replace content item field {id} with name {fieldName}, type {fieldType} and device {deviceType}.

Overwrite the full record of content item field {id}.

DELETE /api/v1/admin/ContentItemFields({id}) Delete one content item field · Delete entity in EntitySet ContentItemFields #

Ask an LLM

“How do I remove a single content item field?”

“Can I delete a content field only when its ETag hasn't changed?”

Tell an agent destructive · confirm first

Delete content item field {id}.

Remove content item field {id} if the ETag matches {etag}.

PATCH /api/v1/admin/ContentItemFields({id}) Update fields of a content item field · Update entity in EntitySet ContentItemFields #

Ask an LLM

“How can I change only the text value of a content field?”

“Can I schedule when an existing content field publishes?”

Tell an agent

Set the text of content item field {id} to {stringValue}.

Schedule content item field {id} to publish on {publishOn}.

GET /api/v1/admin/ContentItemFields/Default.Default() Get defaults for a new content item field · Call operation Default #

Ask an LLM

“What default values does a new content item field get?”

“Where can I get an empty content item field template?”

Tell an agent

Fetch the default content item field template.

Show starting values for a new content field.

DELETE /api/v1/admin/contentitemfields/delete Bulk delete content item fields · Content item fields delete route #

Ask an LLM

“How do I delete many content item fields at once?”

“Can I pass a list of ids to clear several content fields?”

Tell an agent destructive · confirm first

Bulk delete content item fields {ids}.

Permanently delete every content field in {ids}.

GET /api/v1/admin/contentitemfields({key})/customproperties({custompropertyKey}) Get a custom property of a content item field · Content item fields get custom property by key and custompropertykey #

Ask an LLM

“Where can I read a custom property on a content item field?”

“How do I fetch one custom attribute from a content field?”

Tell an agent

Get custom property {custompropertyKey} of content item field {key}.

Read custom attribute {custompropertyKey} on content field {key}.

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-content-item-fields-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-content-item-fields-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

openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Content Item Fields API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Content Item Fields
paths:
  /api/v1/admin/ContentItemFields:
    get:
      tags:
      - Content Item Fields
      summary: Returns the EntitySet ContentItemFields
      operationId: ContentItemFields_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:
      - Content Item Fields
      summary: Post a new entity to EntitySet ContentItemFields
      operationId: ContentItemFields_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.ContentItemField'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ContentItemFields({id}):
    get:
      tags:
      - Content Item Fields
      summary: Returns the entity with the key from ContentItemFields
      operationId: ContentItemFields_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:
      - Content Item Fields
      summary: Replace entity in EntitySet ContentItemFields
      operationId: ContentItemFields_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.ContentItemField'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Content Item Fields
      summary: Delete entity in EntitySet ContentItemFields
      operationId: ContentItemFields_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:
      - Content Item Fields
      summary: Update entity in EntitySet ContentItemFields
      operationId: ContentItemFields_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.ContentItemField'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ContentItemFields/Default.Default():
    get:
      tags:
      - Content Item Fields
      summary: Call operation Default
      operationId: ContentItemFields_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/contentitemfields/delete:
    delete:
      tags:
      - Content Item Fields
      operationId: ContentItemFields_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: Content item fields delete route
      x-summary-source: derived
  /api/v1/admin/contentitemfields({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Content Item Fields
      operationId: ContentItemFields_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: Content item fields get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.ContentItemField:
      required:
      - deviceType
      - fieldType
      - fieldName
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        contentKey:
          format: int32
          type: integer
        languageId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        personaId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        deviceType:
          maxLength: 50
          minLength: 0
          type: string
        fieldType:
          maxLength: 50
          minLength: 0
          type: string
        fieldName:
          maxLength: 100
          minLength: 0
          type: string
        isSharedField:
          type: boolean
        dateTimeValue:
          format: date-time
          type: string
        decimalValue:
          format: double
          type: number
        intValue:
          format: int32
          type: integer
        stringValue:
          type: string
        booleanValue:
          type: boolean
        objectValue:
          format: byte
          type: string
        publishOn:
          format: date-time
          type: string
        approvedOn:
          format: date-time
          type: string
        submittedForApprovalOn:
          format: date-time
          type: string
        createdById:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        approvedById:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        isRetracted:
          type: boolean
        isRollback:
          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