j1.2.0
API Overview
The Experiences API provides a unified endpoint for creating and updating Page Designer pages in B2C Commerce Cloud. Use this API to programmatically create new pages or update existing pages with comprehensive configuration options.
Authentication & Authorization
For resource access, you must use a client ID and client secret from Account Manager to request an access token. The access token is used as a bearer token and added to the Authorization header of your API request.
You must include sfcc.experience.rw in the client ID used to generate the token. For a full list of required permissions, see the Authorization Scopes Catalog.
For detailed setup instructions, see Authorization for Admin APIs.
Use Cases
Unified Create/Update
Create new pages or update existing Page Designer pages with comprehensive configuration.
Component configuration
Define and configure page components with their associated data.
Region Setup
Set up page regions and assign components to them.
Custom Properties
Create custom attributes using the c_* property pattern.
SEO Support
Configure page-level SEO metadata including titles, descriptions, and keywords.
Usage Guidelines
This API is specifically designed for single page creation operations.
- The Page ID must be unique within the site.
- Newly created pages are in draft status by default.
- Existing pages are updated with provided data (partial updates supported).
- Page Activation: To make a page active/published, use the Business Manager UI to change the page status from draft to active.
- Custom properties (c_*) are supported through the open object pattern.
- All text fields support localization through the Commerce Cloud localization framework.
- This API supports both create and update operations using PUT semantics.
Let us know so we can improve!