ServicePresenceStatus

Represents a presence status that can be assigned to a service channel.

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

ServicePresenceStatus components have the suffix .servicePresenceStatus and are stored in the servicePresenceStatuses folder.

Version 

Introduced in API version 44.0.

Special Access Rules 

This type is available only if Omni-Channel is enabled in your org.

Fields 

channels 

  • Type: ServiceChannelStatus
  • Required: No
  • Description: Represents the service channels assigned to the presence status. If no service channels are included, the presence status is automatically marked as ‘Away’ (where IsAway is set to true.)

label 

  • Type: string
  • Required: Yes
  • Description: The label of the presence status.

ServiceChannelStatus Type 

Fields 

channel 

  • Type: string[]
  • Required: No
  • Description: Represents the channels assigned to the presence status.

Declarative Metadata Sample Definition 

The following is an example of a ServicePresenceStatus component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ServicePresenceStatus xmlns="http://soap.sforce.com/2006/04/metadata">
3    <channels>
4        <channel>Case</channel>
5    </channels>
6    <label>Available for Cases</label>
7</ServicePresenceStatus>

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>ServicePresenceStatus</name>
6    </types>
7    <version>44.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.