How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Optimizely Messages API

The Messages API from Optimizely — 11 operation(s) for messages.

Optimizely Messages API is one of 420 APIs that Optimizely publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Message. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 17 operations across 11 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://dogfood.commerce.insitesandbox.com.

17 operations 11 paths 28 schemas 2 DELETE10 GET2 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://exp.mcp.opal.optimizely.com/mcp
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Optimizely Messages API declares 1 security scheme for authenticating requests. An API key is passed in the query as access_token (access_token).

  • access_token — Token used to access storefront API.

Paths & Operations 17

Across 11 paths, the API surfaces 17 operations — 2 DELETE, 10 GET, 2 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Messages 17
GET
/api/v1/admin/Messages
Returns the EntitySet Messages
Messages_Get 8 params → 200
POST
/api/v1/admin/Messages
Post a new entity to EntitySet Messages
Messages_Post body → 200
GET
/api/v1/admin/Messages({id})
Returns the entity with the key from Messages
Messages_GetById 3 params → 200
PUT
/api/v1/admin/Messages({id})
Replace entity in EntitySet Messages
Messages_PutById 1 param body → 200
DELETE
/api/v1/admin/Messages({id})
Delete entity in EntitySet Messages
Messages_DeleteById 2 params → 200
PATCH
/api/v1/admin/Messages({id})
Update entity in EntitySet Messages
Messages_PatchById 1 param body → 200
GET
/api/v1/admin/Messages/Default.Default()
Call operation Default
Messages_Default → 200
DELETE
/api/v1/admin/messages/delete
Messages_DeleteRoute 1 param → 200
GET
/api/v1/admin/messages({key})/customerorderchanges({customerorderchangeKey})
Messages_GetCustomerOrderChangeByKeyAndCustomerorderchangekey 4 params → 200
GET
/api/v1/admin/messages({key})/customproperties({custompropertyKey})
Messages_GetCustomPropertyByKeyAndCustompropertykey 4 params → 200
GET
/api/v1/admin/messages({key})/messageaudits({messageauditKey})
Messages_GetMessageAuditByKeyAndMessageauditkey 4 params → 200
GET
/api/v1/admin/messages({key})/messagestatuses({messagestatusKey})
Messages_GetMessageStatusByKeyAndMessagestatuskey 4 params → 200
GET
/api/v1/admin/messages({key})/messagetargets({messagetargetKey})
Messages_GetMessageTargetByKeyAndMessagetargetkey 4 params → 200
GET
/api/v1/messages
MessagesV1_GetCollectionAsync → 200
POST
/api/v1/messages
MessagesV1_PostAsync body → 200
GET
/api/v1/messages/{messageId}
MessagesV1_GetAsync 1 param → 200
PATCH
/api/v1/messages/{messageId}
MessagesV1_PatchAsync 1 param body → 200

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Insite.Catalog.WebApi.V2.ApiModels.Product.ProductModel (51 properties), Insite.Catalog.WebApi.V2.ApiModels.Product.DetailModel (29 properties), Insite.Catalog.WebApi.V2.ApiModels.Product.ProductSubscriptionModel (21 properties), Insite.Catalog.WebApi.V2.ApiModels.Product.BadgeModel (19 properties). Each schema is shown below with its type and property counts.

Insite.Data.Entities.Message
object
10 properties 2 required
Insite.Catalog.WebApi.V2.ApiModels.Product.FieldScoreModel
object
2 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.TraitValueModel
object
8 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.ProductLineModel
object
4 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.ConfigurationModel
object
3 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.AttributeTypeModel
object
9 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.SectionOptionModel
object
9 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.AttributeValueModel
object
4 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.ContentModel
object
7 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.DocumentModel
object
5 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.BrandModel
object
9 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.ConfigSectionModel
object
5 properties
Insite.Message.WebApi.V1.ApiModels.MessageModel
object
9 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.DetailModel
object
29 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.ProductSubscriptionModel
object
21 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.BadgeModel
object
19 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.ImageModel
object
8 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.ScoreExplanationModel
object
3 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.ProductModel
object
51 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.FieldScoreDetailedModel
object
7 properties
Insite.Message.WebApi.V1.ApiModels.CustomerOrderChangeModel
object
11 properties
Insite.Message.WebApi.V1.ApiModels.MessageCollectionModel
object
3 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.ChildTraitValueModel
object
4 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.UnitOfMeasureModel
object
7 properties
Insite.Message.WebApi.V1.ApiModels.MessageParameter
object
6 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.WarehouseModel
object
4 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.SpecificationModel
object
7 properties
Insite.Catalog.WebApi.V2.ApiModels.Product.VariantTraitModel
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

optimizely-messages-api-openapi.yml Raw ↑

Other APIs Optimizely publishes across the network.

Optimizely Remote MCP Server — Experimentation
Optimizely Assets API
Optimizely Attributes API
Optimizely Audiences API
Optimizely Campaigns API
Optimizely Catalog Entries API
Optimizely Catalog Entry Relations API
Optimizely Catalog Nodes API
Optimizely Catalogs API
Optimizely Content API
Optimizely Content Types API
Optimizely Customers API
Where this information came from

This is an independent, third-party profile of Optimizely Messages API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.