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

sitecore Flow Definitions API

Endpoints for creating, retrieving, and updating flow definitions that represent experiments, experiences, and personalization flows in Sitecore Personalize. Flows can be web-based, full-stack, or triggered by API calls.

sitecore Flow Definitions API is one of 33 APIs that Sitecore publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Flow Definitions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 4 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.boxever.com.

4 operations 2 paths 5 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://edge.sitecorecloud.io/api/graphql
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

sitecore Flow Definitions API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — API key authentication. Provide the API key in the Authorization header obtained from the Sitecore Personalize instance configuration.

Paths & Operations 4

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

Flow Definitions 4

Endpoints for creating, retrieving, and updating flow definitions that represent experiments, experiences, and personalization flows in Sitecore Personalize. Flows can be web-base…

GET
/v1/flow-definitions
List flow definitions
listFlowDefinitions 4 params → 200401
POST
/v1/flow-definitions
Create a flow definition
createFlowDefinition body → 201400401
GET
/v1/flow-definitions/{id}
Get a flow definition
getFlowDefinition 1 param → 200401404
PUT
/v1/flow-definitions/{id}
Update a flow definition
updateFlowDefinition 1 param body → 200400401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are FlowDefinition (7 properties), ErrorResponse (3 properties), CreateFlowDefinitionRequest (3 properties), VariantConfig (2 properties). Each schema is shown below with its type and property counts.

CreateFlowDefinitionRequest
object
Request body for creating or updating a flow definition
3 properties 2 required
FlowDefinitionListResponse
object
A paginated list of flow definitions
2 properties
FlowDefinition
object
A flow definition representing a personalization experiment or experience in Sitecore Personalize
7 properties
ErrorResponse
object
An error response body
3 properties
VariantConfig
object
Configuration for a variant within a decision model or flow
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sitecore-flow-definitions-api-openapi.yml Raw ↑

Other APIs Sitecore publishes across the network.

Sitecore XM Cloud GraphQL Delivery API
Sitecore XM Cloud Authoring and Management GraphQL API
Sitecore CDP Stream API
Sitecore CDP Batch API
Sitecore Content Hub Admin API
sitecore Audit API
sitecore Authentication API
sitecore Buyers API
sitecore Collections API
sitecore Connections API
sitecore Decision Models API
sitecore Download Orders API
Where this information came from

This is an independent, third-party profile of sitecore Flow Definitions 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.