Metadata API Developer Guide
jNote: 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.
SurveySettings
Parent Type and Manifest Access
This type extends the Metadata metadata type and inherits its fullName field.
In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See Settings for more details.
File Suffix and Directory Location
SurveySettings values are stored in a single file named Survey.settings in the settings folder. The .settings files are different from other named components because there is only one settings file for each settings component.
Version
SurveySettings is available in API version 47.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| enableGenerativeAISurveys | boolean | Indicates whether AI-Generated Surveys is enabled for your org (true) or not (false). The default value is false. Available in API version 62.0 and later. |
| enableIndustriesCxmEnabled | boolean | Indicates whether Customer Lifecycle Maps is enabled for your org (true) or not (false). The default value is false. |
| enableSurvey | boolean | Indicates whether Surveys is enabled for your org (true) or not (false). The default value is false. |
| enableSurveyOwnerCanManageResponse | boolean | Indicates whether the owner of a survey can manage its responses. The default value is false. |
Declarative Metadata Sample Definition
This example shows a sample SurveySettings component.
1<?xml version="1.0" encoding="UTF-8"?>
2<SurveySettingsxmlns="http://soap.sforce.com/2006/04/metadata">
3<enableIndustriesCxmEnabled>false</enableIndustriesCxmEnabled>
4<enableSurvey>true</enableSurvey>
5<enableSurveyOwnerCanManageResponse>false</enableSurveyOwnerCanManageResponse>
6<enableGenerativeAISurveys>false</enableGenerativeAISurveys>
7</SurveySettings>This example shows a sample package.xml file 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>Survey</members>
5 <name>Settings</name>
6 </types>
7 <version>61.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.