ProgramCohortMember

Represents program enrollees that are part of a given 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

IsRemovedFromCohort

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates if the program cohort member was removed from the cohort.
Default value: false

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.

Name

Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: The name of the program cohort member.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: ID of the user who owns the record.

This field is a polymorphic relationship field.
Relationship Name: Owner
Relationship Type: Lookup
Refers To: Group, User

ProgramCohortId

Type: reference
Properties: Create, Filter, Group, Sort
Description: The program cohort associated with the program cohort member.

This field is a relationship field.
Relationship Name: ProgramCohort
Relationship Type: Master-detail
Refers To: ProgramCohort (the master object)

ProgramEnrolleeId

Type: reference
Properties: Filter, Group, Nillable, Sort
Description: The account or contact enrolled in the program.

This field is a polymorphic relationship field.

This field is a calculated field.
Relationship Name: ProgramEnrollee
Relationship Type: Lookup
Refers To: Account, Contact

ProgramEnrollmentId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The program enrollment associated with the program cohort member.

This field is a relationship field.
Relationship Name: ProgramEnrollment
Relationship Type: Lookup
Refers To: ProgramEnrollment

ProgramEnrollmentStatus

Type: picklist
Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description: Specifies the status of the program enrollment associated with this cohort member.

This field is a calculated field.
Default value: Applied
Possible values:
- Applied
- Completed
- Denied
- In Progress
- Waitlisted
- Withdrawn

RemovalDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date when the program cohort member was removed from the cohort.

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.

ProgramCohortMemberFeed: Feed tracking is available for the object.
ProgramCohortMemberHistory: History is available for tracked fields of the object.
ProgramCohortMemberOwnerSharingRule: Sharing rules are available for the object.
ProgramCohortMemberShare: Sharing is available for the object.