SalesWorkQueueSettings

Represents settings used to customize work queue options for third-party scoring. In Sales Engagement, you can add a custom number field on person accounts, contacts, or leads. Then, use the custom number field to sort the work queue.

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

SalesWorkQueueSettings components have the suffix .salesworkqueuesetting and are stored in the salesworkqueuesettings folder.

Version 

Introduced in API version 49.0.

Special Access Rules 

You must be a Sales Engagement customer to access this metadata type.

Fields 

featureName 

  • Type: string
  • Required: Yes
  • Description: The feature that the SalesWorkQueueSettings record is configuring. The allowed value is ThirdPartyScore.

targetEntity 

  • Type: string (enumeration of type string)
  • Required: Yes
  • Description: The type that the SalesWorkQueueSettings record is configuring.
  • Possible values:
    • Contact
    • Lead
    • PersonAccount

targetField 

  • Type: string

  • Required: Yes

  • Description: The developer name or ID of the custom number field that is used to sort the work queue. Custom fields must have a custom number data type.

    • To use Einstein Intelligence Score for lead scoring, use ScoreIntelligence.Score for the developer name.
    • To remove custom number fields from the work queue, use None.

Declarative Metadata Sample Definition 

The following is an example of a SalesWorkQueueSettings component. The value for targetField is set to 00NRM000001g55D as an example of a custom field ID. Replace this value with the ID of your custom field.

1<?xml version="1.0" encoding="UTF-8"?>
2<SalesWorkQueueSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <featureName>ThirdPartyScore</featureName>
4    <targetEntity>Contact</targetEntity>
5    <targetField>00NRM000001g55D</targetField>
6</SalesWorkQueueSettings>

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>SalesWorkQueueSettings</name>
6    </types>
7    <version>49.0</version>
8</Package>

Usage 

Create one SalesWorkQueueSettings record for each type. For example, suppose that you want to create a work queue to sort leads by your custom field called customLeadScore. Create a SalesWorkQueueSettings record and set featureName to ThirdPartyScore, targetEntity to Lead, and targetField to customLeadScore.

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.