Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

DigitalExperienceConfig

Represents details for your organization’s workspaces, such as the site label, site URL path prefix, and workspace type.

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

DigitalExperienceConfig components have the suffix .digitalExperienceConfig and are stored in the digitalExperienceConfigs folder.

Version

DigitalExperienceConfig components are available in API version 56.0 and later.

Special Access Rules

You can use DigitalExperienceConfig for enhanced LWR sites created after the Winter ’23 release.

Fields

Field Name	Description
label	Field Type string Description Required. The name of the site.
site	Field Type Site Description Required. Contains site-related settings, such as the site’s URL path prefix.
space	Field Type string Description Required. References the workspace that contains the site’s content items such as brandingSets, themes, views, and routes.

Site

Represents site-related information, such as the URL path prefix.

Field Name	Description
urlPathPrefix	Field Type string Description The first part of the path on the site's URL that distinguishes this site from other sites. For example, if your site URL is `MyDomainName`.my.site.com/partners, then partners is the urlPathPrefix.

Declarative Metadata Sample Definition

The following is an example of a DigitalExperienceConfig component.

1<?xml version="1.0" encoding="UTF-8"?>
2<DigitalExperienceConfig xmlns="http://soap.sforce.com/2006/04/metadata">
3    <label>Capricorn_Coffee</label>
4    <site>
5        <urlPathPrefix>CapricornCoffee</urlPathPrefix>
6    </site>
7    <space>site/Capricorn_Coffee1</space>
8</DigitalExperienceConfig>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>Capricorn_Coffee1</members>
5        <name>DigitalExperienceConfig</name>
6    </types>
7    <version>56.0</version>
8</Package>

Usage

To retrieve and deploy DigitalExperienceConfig, use legacy sfdx commands.

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide