ProgramCohort

Represents information about the participants of a program cohort. This object is available in API version 61.0 and later.

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

Supported Calls

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

Special Access Rules

This object is available only if the Advanced Program Management license is enabled, Program Cohorts are enabled, and the Advanced Program Management system permission is assigned to users.

Fields

Field Details
CurrentMemberCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of members that are actively participating in the cohort.
This is a roll-up summary field.
Description
Type
textarea
Properties
Create, Nillable, Update
Description
The description of the program cohort.
EndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The end date of the program cohort.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly.
MaximumMemberCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The maximum number of members that can be active in a cohort. Add custom validation to enforce this maximum count.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the program cohort.
ProgramId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The program associated with the cohort.
This field is a relationship field.
Relationship Name
Program
Relationship Type
Master-detail
Refers To
Program (the master object)
StartDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The start date of the program cohort.
Status
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the status of the program cohort.
Possible values are:
  • Active
  • Canceled
  • Completed
  • Planned

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

ProgramCohortFeed
Feed tracking is available for the object.
ProgramCohortHistory
History is available for tracked fields of the object.