---
schema_version: "1"
id: 0547b294ec6ad82cff4f7682886eabb4e2fafdbb7b77dba253d6598e07286793
title: ShiftSegment
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_shiftsegment.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_shiftsegment.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 6cff74439bfe1fa0678d9dae4b277dd061e25299b48aec5f7309b83b96f94a38
description: Represents a scheduled activity within a shift. This object is available in API version 55.0 and later.
---
# ShiftSegment

Represents a scheduled activity within a shift. This object is available in API version 55.0 and later.

## Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

## Special Access Rules

The org must have the Workforce Engagement license and Workforce Engagement must be enabled. The user requires the Workforce Engagement Planner or Workforce Engagement Admin permission set.

## Fields

| Field | Details |
| --- | --- |
| EndTime | 
Type

dateTime

Properties

Create, Filter, Sort, Update

Description

The date and time when the shift segment ends.



 |
| IsInAdherence | 

Type

boolean

Properties

Create, Defaulted on create, Filter, Group, Sort

Description

Indicates whether the agent is in adherence (true) or not (false) for the scheduled segment activity.

The default value is true.



 |
| Name | 

Type

string

Properties

Autonumber, Defaulted on create, Filter, idLookup, Sort

Description

The name of the shift segment.



 |
| SegmentTypeId | 

Type

reference

Properties

Create, Filter, Group, Sort, Update

Description

The unique ID of the associated shift segment type.

This is a relationship field.

Relationship Name

SegmentType

Relationship Type

Lookup

Refers To

ShiftSegmentType



 |
| ShiftId | 

Type

reference

Properties

Create, Filter, Group, Sort

Description

The unique ID of the shift in which the segment is scheduled.

This is a relationship field.

Relationship Name

Shift

Relationship Type

Lookup

Refers To

Shift



 |
| StartTime | 

Type

dateTime

Properties

Create, Filter, Sort, Update

Description

The date and time when the shift segment starts.



 |