Optimizely

Optimizely Message Statuses API

The Message Statuses API from Optimizely — 5 operation(s) for message statuses.

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/MessageStatuses List message read statuses · Returns the EntitySet MessageStatuses #
Ask an LLM
“Which users have read the site messages I posted?”
“Can I filter message statuses to unread ones for one user?”
Tell an agent
List all message statuses.
List message statuses where {filter}.
POST /api/v1/admin/MessageStatuses Record a message status for a user · Post a new entity to EntitySet MessageStatuses #
Ask an LLM
“How do I track whether a user has read a specific message?”
“Can I create a read status linking a message to a user profile?”
Tell an agent
Create a status for message {messageId} and user profile {userProfileId}.
Record message {messageId} as read {hasRead} for user {userProfileId}.
GET /api/v1/admin/MessageStatuses({id}) Get a message status by id · Returns the entity with the key from MessageStatuses #
Ask an LLM
“Has a given message status been marked as read?”
“Can I look up one message status record by id?”
Tell an agent
Get message status {id}.
Fetch message status {id} with {expand} expanded.
PUT /api/v1/admin/MessageStatuses({id}) Replace a message status · Replace entity in EntitySet MessageStatuses #
Ask an LLM
“How do I overwrite an entire message status record?”
“What does a full replacement of a message status need?”
Tell an agent
Replace message status {id} for message {messageId} and user {userProfileId}.
Overwrite message status {id} with read state {hasRead}.
DELETE /api/v1/admin/MessageStatuses({id}) Delete a message status · Delete entity in EntitySet MessageStatuses #
Ask an LLM
“Can I remove a single message status by its id?”
“Does deleting a message status support an If-Match ETag?”
Tell an agent destructive · confirm first
Delete message status {id}.
Delete message status {id} if its ETag is {etag}.
PATCH /api/v1/admin/MessageStatuses({id}) Mark a message as read or unread · Update entity in EntitySet MessageStatuses #
Ask an LLM
“How do I flip one message status to read without resending the rest?”
“Can I mark a message as unread again for a user?”
Tell an agent
Mark message status {id} as read {hasRead}.
Set has-read to {hasRead} on status {id}.
GET /api/v1/admin/MessageStatuses/Default.Default() Get a blank message status template · Call operation Default #
Ask an LLM
“What default values does a new message status start with?”
“Is there an empty message status template to fill in?”
Tell an agent
Get the default message status template.
Show the defaults for a new message status.
DELETE /api/v1/admin/messagestatuses/delete Bulk delete message statuses · Message statuses delete route #
Ask an LLM
“Can I delete several message statuses in one request?”
“How do I clear a batch of message read records by id?”
Tell an agent destructive · confirm first
Bulk delete message statuses {ids}.
Remove the message statuses with ids {ids}.
GET /api/v1/admin/messagestatuses({key})/customproperties({custompropertyKey}) Get a custom property of a message status · Message statuses get custom property by key and custompropertykey #
Ask an LLM
“What custom property values are stored on a message status?”
“Can I read one extension field from a message status?”
Tell an agent
Get custom property {custompropertyKey} of message status {key}.
Read custom field {custompropertyKey} on message status {key}.

Specifications

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