Queue

Represents a holding area for items before they are processed.

Declarative Metadata File Suffix and Directory Location

The file suffix for queue components is .queue and components are stored in the queues directory of the corresponding package directory. This component supports cases, leads, service contracts (if Entitlements are enabled), and custom objects.

Version

Queue components are available in API version 24.0 and later.

Fields

This metadata type represents the valid values that define a queue:

Field Name	Field Type	Description
doesSendEmailToMembers	boolean	Indicates whether emails are sent to queue members (`true`) or not (`false`) when a new record is added to the queue.
email	string	The email address of the queue owner.
fullName	string	The unique identifier for API access. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is inherited from the Metadata component. Corresponds to Queue Name in the user interface.
name	string	Required. The name of the queue. Corresponds to Label in the user interface.
queueSobject	QueueSobject[]	Indicates the supported entity types.

QueueSobject

QueueSobject represents an entity type that the queue supports.

Field Name	Field Type	Description
sobjectType	string	Valid values are: `Case` `Lead` `ServiceContract` Custom objects (e.g. `ObjA_c`)

Declarative Metadata Sample Definition

The following is the definition of a queue, which supports Case, Lead, and a custom object named ObjA.

1<?xml version="1.0" encoding="UTF-8"?>
2<Queue xmlns="http://soap.sforce.com/2006/04/metadata">
3    <doesSendEmailToMembers>true</doesSendEmailToMembers>
4    <email>member@company.com</email>
5    <fullName>Your Name</fullName>
6    <name>memberQueue</name>
7    <queueSobject>
8        <sobjectType>Case</sobjectType>
9    </queueSobject>
10    <queueSobject>
11        <sobjectType>Lead</sobjectType>
12    </queueSobject>
13    <queueSobject>
14        <sobjectType>ObjA_c</sobjectType>
15    </queueSobject>
16</Queue>

Metadata API Developer’s Guide