Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

PresenceUserConfig

Represents a configuration that determines a presence user’s settings. This object is available in API version 32.0 and later.

Supported Calls

create(), delete(), describeSObjects(), update(), query(), retrieve()

Special Access Rules

To access this object, Omni-Channel must be enabled.

As of Spring ’20 and later, only authenticated internal and external users can access this object.

Fields

Field	Details
Capacity	Type int Properties Create, Filter, Group, Sort Description The maximum number of work assignments that can be pushed to an agent at a time.
DeveloperName	Type string Properties Create, Filter, Group, Sort Description The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. Note
Language	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of the presence configuration.
MasterLabel	Type string Properties Create, Filter, Group, Sort Description The label of the presence configuration.
OptionsIsAutoAcceptEnabled	Type boolean Properties Create, Filter Description Indicates whether work items that are routed to agents are automatically accepted (`true`) or not (`false`). Available only if OptionsIsDeclineEnabled is set to `false`.
OptionsIsDeclineEnabled	Type boolean Properties Create, Filter Description Indicates whether agents can decline work items that are routed to them (`true`) or not (`false`). Available only if OptionsIsAutoAcceptEnabled is set to `false`.
OptionsIsDeclineReasonEnabled	Type boolean Properties Create, Filter Description Indicates whether agents can select a reason for declining work requests (`true`) or not (`false`). This can be selected only if decline reasons are enabled.
OptionsIsDisconnectSoundEnabled	Type boolean Properties Create, Filter Description Indicates whether a sound is played when agents are disconnected from Omni-Channel (`true`) or not (`false`).
OptionsIsRequestSoundEnabled	Type boolean Properties Create, Filter Description Indicates whether a sound plays with incoming work requests (`true`) or not (`false`). Set to `true` by default.
PresenceStatusOnDeclineId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the presence status that’s automatically assigned to the agent when the agent declines a work item. Available only if OptionsIsDeclineEnabled is set to `true`.
PresenceStatusOnPushTimeoutId	Type reference Properties Create, Filter, Group, Nillable, Sort Description The ID of the presence status that’s automatically assigned to the agent when the agent doesn’t respond to a work item before push timeout occurs. Available in API version 36.0 and later.