SurveySettings

Represents an org’s survey settings. Use the SurveySettings component to enable Salesforce Surveys, enable Customer Lifecycle Maps, and choose whether the owner of a survey can manage the responses.

Parent Type 

This type extends Metadata and inherits its fields.

Manifest Access 

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 

Introduced in API version 47.0.

Fields 

enableConversationalSurveys 

  • Type: boolean
  • Required: No

enableGenerativeAISurveys 

  • Type: boolean
  • Required: No
  • Introduced: API version 62.0
  • Description: Indicates whether AI-Generated Surveys is enabled for your org (true) or not (false). The default value is false.

enableIndustriesCxmEnabled 

  • Type: boolean
  • Required: No
  • Description: Indicates whether Customer Lifecycle Maps is enabled for your org (true) or not (false). The default value is false.

enableSurvey 

  • Type: boolean
  • Required: No
  • Description: Indicates whether Surveys is enabled for your org (true) or not (false). The default value is false.

enableSurveyInvLinkWithoutAppExtension 

  • Type: boolean
  • Required: No

enableSurveyOwnerCanManageResponse 

  • Type: boolean
  • Required: No
  • Description: Indicates whether the owner of a survey can manage its responses. The default value is false.

enableSurveyScrt2Api 

  • Type: boolean
  • Required: No

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.