---
schema_version: "1"
id: 3715eb73e9942b25c33ab83e47c2cd5194ca99e29e2b452831ac7594913fb513
title: ChoiceList
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_choicelist.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_choicelist.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 94048a9d1ab16cbd1130522b595c57cb50855e63f4a167d3d24303d761384d68
description: Represents the Choicelist dropdown field that’s used for pre-chat.
---
# ChoiceList

Represents the Choicelist dropdown field that’s used for pre-chat.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") 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\[\]](#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\[\]](meta_embeddedserviceconfig.htm "Represents a setup node for creating an Embedded Service for Web deployment. This type extends the Metadata metadata type and inherits its fullName field.")

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.

<?xml version="1.0" encoding="UTF-8"?>
<ChoiceList xmlns="http://soap.sforce.com/2006/04/metadata">
    <choiceListValue\>
        <embeddedServiceCustomLabels\>
            <customLabel\>EM\_PreChat\_ChoiceList\_PrechatCustomFieldLabel\_133xx0000004GG1\_7741637</customLabel\>
            <labelKey\>EM\_PreChat\_ChoiceList\_PrechatCustomFieldLabel</labelKey\>
            <feature\>EmbeddedMessaging</feature\>
        </embeddedServiceCustomLabels\>
        <isDefaultValue\>true</isDefaultValue\>
        <order\>0</order\>
        <valueName\>Pizza</valueName\>
    </choiceListValue\>
    <choiceListValue\>
        <embeddedServiceCustomLabels\>
            <customLabel\>EM\_PreChat\_ChoiceList\_PrechatCustomFieldLabel\_133xx0000004GG2\_5523047</customLabel\>
            <labelKey\>EM\_PreChat\_ChoiceList\_PrechatCustomFieldLabel</labelKey\>
            <feature\>EmbeddedMessaging</feature\>
        </embeddedServiceCustomLabels\>
        <isDefaultValue\>false</isDefaultValue\>
        <order\>1</order\>
        <valueName\>Burger</valueName\>
    </choiceListValue\>
    <masterLabel\>Food</masterLabel\>
    <description\>Food Choice List</description\>
</ChoiceList\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>\*</members>
        <name>ChoiceList</name>
    </types>
    <version>62.0</version>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).