ChoiceList | Metadata API Developer Guide

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

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

File Suffix and Directory Location

ChoiceList components have the suffix .ChoiceList and are stored in the ChoiceList folder.

Version

ChoiceList components are available in API version 62 and later.

Special Access Rules

There are no additional access requirements that are specific to this type.

Fields

Field Name	Description
choiceListValue	Field Type ChoiceListValue[] Description A list of choices to display in the choice list.
description	Field Type string Description A description of the choice list.
masterLabel	Field Type string Description Required. The label for the choice list.

ChoiceListValue

Represents a choice list value in the pre-chat dropdown. ChoiceListValue is available in API version 62 or later.

Field Name	Description
embeddedServiceCustomLabels	Field Type EmbeddedServiceCustomLabel[] Description Custom labels for the choicelist value.
isDefaultValue	Field Type boolean Description Required. Indicates whether the choicelist value should be selected by default.
order	Field Type int Description Required. The order of the choicelist value in the choicelist dropdown field.
valueName	Field Type string Description Required. The value of the choicelist.

Declarative Metadata Sample Definition

The following is an example of a Choicelist component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ChoiceList xmlns="http://soap.sforce.com/2006/04/metadata">
3    <choiceListValue>
4        <embeddedServiceCustomLabels>
5            <customLabel>EM_PreChat_ChoiceList_PrechatCustomFieldLabel_133xx0000004GG1_7741637</customLabel>
6            <labelKey>EM_PreChat_ChoiceList_PrechatCustomFieldLabel</labelKey>
7            <feature>EmbeddedMessaging</feature>
8        </embeddedServiceCustomLabels>
9        <isDefaultValue>true</isDefaultValue>
10        <order>0</order>
11        <valueName>Pizza</valueName>
12    </choiceListValue>
13    <choiceListValue>
14        <embeddedServiceCustomLabels>
15            <customLabel>EM_PreChat_ChoiceList_PrechatCustomFieldLabel_133xx0000004GG2_5523047</customLabel>
16            <labelKey>EM_PreChat_ChoiceList_PrechatCustomFieldLabel</labelKey>
17            <feature>EmbeddedMessaging</feature>
18        </embeddedServiceCustomLabels>
19        <isDefaultValue>false</isDefaultValue>
20        <order>1</order>
21        <valueName>Burger</valueName>
22    </choiceListValue>
23    <masterLabel>Food</masterLabel>
24    <description>Food Choice List</description>
25</ChoiceList>

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>*</members>
5        <name>ChoiceList</name>
6    </types>
7    <version>62.0</version>
8</Package>

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.