SiteSettings | Metadata API Developer Guide

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

In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for details.

File Suffix and Directory Location

SiteSettings values are stored in a single file named Site.settings in the settings directory. The .settings files are different from other named components because there’s only one .settings file for each settings component.

Version

SiteSettings components are available in API version 47.0 and later.

Fields

Field Name	Field Type	Description
enableEnhancedSitesAndContentPlatform	boolean	Indicates whether the enhanced sites and content platform for Experience Cloud is enabled for your org (`true`) or not (`false`). The default is `true`. When `true`, new LWR sites and enhanced CMS workspaces are hosted together on a redesigned platform that offers partial deployment, site content search, and easy content management. Enhanced LWR sites are represented by the DigitalExperienceBundle and DigitalExperienceConfig types. Available in API version 56.0 and later.
enableExperienceFriendlyUrls	boolean	Indicates whether SEO-friendly URL snippets, or “slugs,” are enabled for your org (`true`) or not (`false`). The default is `false`. When `true`, available only in B2C Commerce LWR sites. Available only in API version 58.0. In API version 59.0 and later, use expFriendlyUrlsAsDefault in the Network type.
enableProxyLoginICHeader	boolean	Indicates whether security tokens for API logins from callouts (in API version 31.0 and earlier) are required (`true`) or not (`false`). The default value is `true`.
enableSitesRecordReassignOrgPref	boolean	When `true`, indicates when the org assigns records created by guest users of a site to a default owner in the org. When `false`, the guest user remains the owner of the record. The default value is `false`. Available in API version 48.0 and later.
enableTopicsInSites	boolean	Indicates whether guest and authenticated external users can view topics in Salesforce Sites and Salesforce portals (`true`) or not (`false`). The default value is `false`.
enableVisualforceApiAccessAllowed	boolean	Deprecated in API version 52.0 and later. Allow users of Visualforce pages to override API access control restrictions and access APIs when the enableAdminApprovedAppsOnly in ConnectedAppSettings is enabled (`true`). The default value is `false`.
enableWebruntimeBYOTemplate	boolean	Indicates whether the Build Your Own (LWC) template is available in Experience Builder. The default value is `false`. Available in API version 48.0 and later. Removed in API version 51.0.

Declarative Metadata Sample Definition

The following is an example of a SiteSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<SiteSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3     <enableProxyLoginICHeader>true</enableProxyLoginICHeader>
4     <enableTopicsInSites>false</enableTopicsInSites>
5</SiteSettings>

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>Site</members>
5        <name>Settings</name>
6    </types>
7    <version>47.0</version>
8</Package>

Wildcard Support in the Manifest File

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.