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 Settings API

The Settings API from Optimizely — 9 operation(s) for settings.

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

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

This API exposes 10 operations across 9 paths, and defines 38 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://dogfood.commerce.insitesandbox.com, https://api.cmp.optimizely.com/v3.

10 operations 9 paths 38 schemas 9 GET1 POST

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, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Optimizely Settings API declares 2 security schemes for authenticating requests. An API key is passed in the query as access_token (access_token). It supports OAuth 2.0 (OAuth2) using the authorizationCode and clientCredentials flows, exposing 3 scopes.

  • access_token — Token used to access storefront API.

Paths & Operations 10

Across 9 paths, the API surfaces 10 operations — 9 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Settings 10
GET
/api/v1/settings/website
WebsitesV1_GetSettingsAsync → 200
GET
/api/v1/settings/quote
QuotesV1_GetSettingsAsync → 200
GET
/api/v1/settings/cart
CartsV1_GetSettingsAsync → 200
GET
/api/v1/settings/account
AccountsV1_GetSettingsAsync → 200
GET
/api/v1/settings/wishlist
WishListsV1_GetSettingsAsync → 200
GET
/api/v1/settings
SettingsV1_GetAsync → 200
GET
/api/v1/settings/products
ProductsV1_GetSettingsAsync → 200
GET
/api/v1/settings/mobileapp
MobileAppV1_GetSettingsAsync → 200
GET
/settings
GET /settings
getSettings → 200401403
POST
/settings
POST /settings
updateSettings 2 params body → 200401403422

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are Insite.Websites.WebApi.V1.ApiModels.WebsiteSettingsModel (49 properties), Insite.Catalog.WebApi.V1.ApiModels.ProductSettingsModel (41 properties), Insite.Cart.WebApi.V1.ApiModels.CartSettingsModel (21 properties), Insite.Account.WebApi.V1.ApiModels.AccountSettingsModel (21 properties). Each schema is shown below with its type and property counts.

Insite.Websites.WebApi.V1.ApiModels.WebsiteSettingsModel
object
49 properties
Insite.Rfq.WebApi.V1.ApiModels.QuoteSettingsModel
object
4 properties
Insite.Cart.WebApi.V1.ApiModels.CartSettingsModel
object
21 properties
Insite.Catalog.WebApi.V1.ApiModels.ProductSettingsModel
object
41 properties
Insite.WishLists.WebApi.V1.ApiModels.WishListSettingsModel
object
9 properties
Insite.MobileApp.WebApi.V1.ApiModels.MobileAppSettingsModel
object
8 properties
Insite.Account.WebApi.V1.ApiModels.AccountSettingsModel
object
21 properties
SettingsResources
object
7 properties 7 required
LogicRuleCondition
object
Logic rule action associated condition
2 properties 2 required
SettingsChangeset
object
2 properties 2 required
NumberCustomField
object
3 properties 3 required
LogicRule
object
2 properties 2 required
WorkflowLabel
object
4 properties 4 required
SettingsWebhook
object
5 properties 5 required
Section
object
2 properties 2 required
WorkflowChannel
object
2 properties 2 required
SettingsUpdateResponse
object
2 properties 2 required
MultipleOptionCustomField
object
2 properties 2 required
SettingsLabelGroupLabel
object
2 properties 2 required
SettingsWorkflow
object
10 properties 10 required
Error
object
Error payload
2 properties 1 required
PercentageCustomField
object
2 properties 2 required
WorkflowCustomfield
object
4 properties 4 required
SettingsLabelGroup
object
3 properties 3 required
Settings
object
1 property 1 required
FormField
object
7 properties 7 required
LogicRuleAction
object
Template logic rule action
3 properties 3 required
CurrencyCustomField
object
4 properties 4 required
Instruction
object
2 properties 2 required
SettingsRoutingRule
object
5 properties 5 required
SettingsCustomField
object
Settings for custom fields
13 properties 13 required
WorkflowSubStep
object
6 properties 5 required
SettingsApp
object
6 properties 6 required
LogicRuleTargetField
object
Template logic rule action's target field
3 properties 3 required
SettingsChangesetBase
object
7 properties 7 required
SettingsTemplate
object
7 properties 7 required
LabelOnlyCustomField
object
1 property 1 required
WorkflowStep
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

optimizely-settings-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 Settings 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.