Persists a single custom-role participant assignment on a Lead - ie a participant filling a role beyond the 4 legacy system roles (customer/customer_org/assigned_org/owner), which continue to be stored directly on Lead's own fields. See Lead.getAllParticipants/addParticipant/removeParticipant for the unified API that merges these persisted rows with the legacy fields, and FunnelManager.getLeadRoleDefs for how the roleKey values here relate to configured LeadRoleDefs.

Group: Database Entities

Implements: Serializable, Relational


Properties

PropertyReturnsDescription
createDateDateWhen the participant was added to the lead.
createdByProfileThe profile who added this participant. Can be null when the assignment was made by a journey or an import rather than by a user.
idlongThe database-assigned unique identifier for this participant assignment.
leadLeadThe lead this participant is assigned to. Always set.
participantBaseEntityThe profile or organisation filling the role. Typed as BaseEntity because either can be a participant, so check the concrete type before treating it as a profile.
roleKeyStringWhich role the participant fills on the lead, matching a LeadRoleDef roleKey configured on the lead's funnel. The four legacy system roles are not stored here, they live on Lead's own fields.

Methods

getId()

Returns: long

The database-assigned unique identifier for this participant assignment.

rowId()

Returns: Long

The database identifier for this assignment, as the generic row id used across Kademi entities. Same value as the id.

getLead()

Returns: Lead

The lead this participant is assigned to. Always set.

getRoleKey()

Returns: String

Which role the participant fills on the lead, matching a LeadRoleDef roleKey configured on the lead's funnel. The four legacy system roles are not stored here, they live on Lead's own fields.

getParticipant()

Returns: BaseEntity

The profile or organisation filling the role. Typed as BaseEntity because either can be a participant, so check the concrete type before treating it as a profile.

getCreateDate()

Returns: Date

When the participant was added to the lead.

getCreatedBy()

Returns: Profile

The profile who added this participant. Can be null when the assignment was made by a journey or an import rather than by a user.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.