TrailheadSettings

Represents an org’s access to myTrailhead. 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 more details.

File Suffix and Directory Location

TrailheadSettings values are stored in the Trailhead.settings file in the settings directory. The .settings files are different from other named components because there is only one settings file for each settings component.

Version

TrailheadSettings components are available in API version 47.0 and later.

Special Access Rules

TrailheadSettings is available only in orgs that have myTrailhead enabled.

Fields

Field Name	Field Type	Description
enableMyTrailheadPref	boolean	Indicates whether a customer has access to myTrailhead (`true`) or not (`false`). The default value of this field is `true`.

Declarative Metadata Sample Definition

The following is an example of a TrailheadSettings component.

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

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>Trailhead</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.

Metadata API Developer Guide