Optimizely

Optimizely Application Messages API

The Application Messages API from Optimizely — 5 operation(s) for application messages.

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/ApplicationMessages List application messages · Returns the EntitySet ApplicationMessages #
Ask an LLM
“Which storefront messages and labels are defined in my Optimizely commerce site?”
“Can I filter application messages by name?”
Tell an agent
List all application messages.
List application messages matching {filter}.
POST /api/v1/admin/ApplicationMessages Create an application message · Post a new entity to EntitySet ApplicationMessages #
Ask an LLM
“How do I add a new message text that the storefront displays?”
“Can I create an application message for just one website?”
Tell an agent
Create application message {name} described as {description} with text {message}.
Add message {name} ({description}) reading {message} for website {websiteId}.
GET /api/v1/admin/ApplicationMessages({id}) Get an application message · Returns the entity with the key from ApplicationMessages #
Ask an LLM
“What text does a particular application message show?”
“How do I fetch one application message by id?”
Tell an agent
Get application message {id}.
Show the text of application message {id}.
PUT /api/v1/admin/ApplicationMessages({id}) Replace an application message · Replace entity in EntitySet ApplicationMessages #
Ask an LLM
“How do I overwrite an application message record entirely?”
“Can I replace a message's name, description and text in one request?”
Tell an agent
Replace application message {id} with name {name}, description {description} and text {message}.
Fully rewrite application message record {id}.
DELETE /api/v1/admin/ApplicationMessages({id}) Delete an application message · Delete entity in EntitySet ApplicationMessages #
Ask an LLM
“How do I remove an application message?”
“Can I delete a message only if it hasn't changed since I fetched it?”
Tell an agent destructive · confirm first
Delete application message {id}.
Delete application message {id} if its ETag is {etag}.
PATCH /api/v1/admin/ApplicationMessages({id}) Edit an application message's text · Update entity in EntitySet ApplicationMessages #
Ask an LLM
“How do I change the wording of an existing storefront message?”
“Can I update only the message text and leave the rest alone?”
Tell an agent
Change application message {id}'s text to {message}.
Update the description of application message {id} to {description}.
GET /api/v1/admin/ApplicationMessages/Default.Default() Get a blank default application message · Call operation Default #
Ask an LLM
“What does an empty application message object contain?”
“Is there a default template for a new application message?”
Tell an agent
Get the default template for a new application message.
Show the blank application message object.
DELETE /api/v1/admin/applicationmessages/delete Delete several application messages · Application messages delete route #
Ask an LLM
“Can I delete a batch of application messages in one request?”
“How do I bulk-remove messages by id?”
Tell an agent destructive · confirm first
Delete application messages {ids}.
Bulk-remove the application messages with ids {ids}.
GET /api/v1/admin/applicationmessages({key})/customproperties({custompropertyKey}) Get an application message custom property · Application messages get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property on an application message?”
“Can application messages carry extra custom properties?”
Tell an agent
Get custom property {custompropertyKey} of application message {key}.
Show application message {key}'s custom property {custompropertyKey}.

Specifications

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