ShiftSegmentType

Represents shift segment type settings for Shift Scheduling and Workforce Engagement.

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.

Important

Version 

Introduced in API version 55.0.

Supported SOAP API Calls 

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

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules 

• This object is available only if Shift Scheduling or Workforce Engagement is enabled in your org. To view, create, edit, and delete records, the user requires the Shift Scheduling Planner or Workforce Engagement Planner permission set.

Fields 

AdherenceThreshold 

• Type: int

• Required: No

• Properties: Filter, Group, Sort

• Description: A threshold, in minutes. If the agent starts the scheduled activity within this threshold, the shift segment activity is in adherence.

Category 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: A category for the type of shift segment.

• Possible values:

  • Work — Work — Work activities, such as answering calls, responding to chats, or handling cases.

  • Break — Break — Break times, such as a coffee or lunch break.

  • NonWork — Non-Work — Non-working activities, such as training or meetings.

Color 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Sets a background color when shift activities of this type are displayed in the UI. Use a 3- or 6-digit hexadecimal format, for example #FF00FF.

DeveloperName 

• Type: string

• Required: No

• Properties: 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. Label is Record Type Name. This field is automatically generated, but you can supply your own value if you create the record using the API.

  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

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 55.0

• Description: The full name of the associated metadata type in Metadata API. The full name can include a namespace prefix.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

IsActive 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: Indicates if the shift segment type is active (true) or not (false).

The default value is true.

Language 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Description: The language of the shift segment type.

Possible values are the languages that Workforce Engagement supports.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

ManageableState 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Indicates the manageable state of the specified component that is contained in a package:

• beta

• deleted

• deprecated

• deprecatedEditable

• installed

• installedEditable

• released

• unmanaged

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, idLookup, Sort

• Description: The label of the shift segment type.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 55.0

• Description: Shift Segment Type metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values:

• In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer.
• In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.

ServicePresenceStatusId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Relationship name: ServicePresenceStatus

• Relationship type: relationship

• Refers to: ServicePresenceStatus