Experiences

Experiences are the top-level units of content in Experience Orchestration — composed of components, fragments, and design tokens, they represent a deliverable page or surface.

Design property values

Each design-property assignment supports either a direct value or a legacy dimension-keyed map of values. Use the direct form for new experiences and updates. The legacy form remains supported for existing experiences that use viewport-specific values.

Direct values do not depend on the optional viewports field:

{
  "designProperties": {
    "backgroundColor": {
      "type": "ManualDesignValue",
      "value": "#ffffff"
    }
  }
}

Legacy values are keyed by the dimension or viewport identifier:

{
  "designProperties": {
    "backgroundColor": {
      "<dimension-key>": {
        "type": "ManualDesignValue",
        "value": "#ffffff"
      }
    }
  }
}

The viewports field is deprecated and will be removed in a future release. Clients should accept responses with or without it.

Experiences collection

List all experiences

Create a new experience

Experience

Get an experience by ID

Upsert an experience by ID

Delete an experience by ID

Publishing

Publish an experience

Unpublish an experience

References

Get referenced entities for an experience