LoyaltyProgramMember

Represents information about member who belongs to a loyalty program. The member can be individual or corporate type. This object is available in API version 51.0 and later.

Supported Calls

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

Fields

AccountId

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: ID of the account with which the loyalty program member is associated. This field is optional for a Group type member.

This is a relationship field.

Relationship Name: Account

Relationship Type: Lookup

Refers To: Account

CanReceivePartnerPromotions

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: Indicates whether the member can receive partner promotions for the program (true) or not (false).

CanReceivePromotions

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: Indicates whether the member can receive promotions for the program (true) or not (false).

ContactId

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: ID of the contact with which the loyalty program member is associated. This field is optional for a Group type member.

This is a relationship field.

Relationship Name: Contact

Relationship Type: Lookup

Refers To: Contact

EnrollmentChannel

Type: picklist

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

Description: Channel through which membership is enrolled.

Possible values are:

CallCenter
Email
Franchise
Mobile
Partner
POS
Print
Social
Store
Web

EnrollmentDate

Type: date

Properties: Create, Filter, Group, Sort, Update

Description: Required. Date when the member enrolled to the loyalty program.

GroupCreatedByMemberId

Type: reference

Properties: Create, Filter, Group, Nillable, Sort

Description: The Individual or Corporate type loyalty program member who created the group or requested for the group to be created. This field is available in API version 53.0 and later.

This is a relationship field.

Relationship Name: GroupCreatedByMember

Relationship Type: Lookup

Refers To: LoyaltyProgramMember

GroupName

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The name of the group when the type of membership in the loyalty program is Group. This field is available in API version 53.0 and later.

IsEligibleForTierAssessment

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: Indicates whether the member is eligible for tier assessment. A member is eligible for tier assessment when there is a change in their qualifying points balance. This field is available in API version 58.0 and later.

The default value is false.

LastActivityDate

Type: date

Properties: Filter, Group, Nillable, Sort, Update

Description: The date when the loyalty program member last performed a transaction.

LastReferencedDate

Type: dateTime

Properties: Filter, Nillable, Sort

Description: The most recent date on which a user referenced this record.

LastViewedDate

Type: dateTime

Properties: Filter, Nillable, Sort

Description: The most recent date on which a user viewed this record.

MemberStatus

Type: picklist

Properties: Create, Filter, Group, Sort, Update

Description: Required. The status of the member in the loyalty program.

Possible values are:

Active
Inactive
Merged—This value is available in API version 56.0 and later.

MemberType

Type: picklist

Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort

Description: Required. The type of membership in the loyalty program.

Possible values are:

Corporate
Group
Individual

MembershipEndDate

Type: date

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The date on which the membership ends.

MembershipLastRenewalDate

Type: date

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The most recent date when the membership was renewed.

MembershipNumber

Type: string

Properties: Create, Filter, Group, idLookup, Sort, Update

Description: The membership number of the loyalty program.

OwnerId

Type: reference

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: The ID of the user who owns this record.

This is a polymorphic relationship field.

Relationship Name: Owner

Relationship Type: Lookup

Refers To: Group, User

PreviousActivityDate

Type: date

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The date when the loyalty program member performed the second-last transaction.

This field is available in API version 67.0 and later.

ProgramId

Type: reference

Properties: Create, Filter, Group, Nillable, Sort

Description: ID of the loyalty program.

This is a relationship field.

Relationship Name: Program

Relationship Type: Lookup

Refers To: LoyaltyProgram

ReferralCode

Type: string

Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update

Description: The code that the member can share with others who want to join the loyalty program. If no referral code is entered during enrollment, an automatic referral code is generated for the member. This field is available in API version 57.0 and later.

ReferredById

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: Reference to Member who referred to the program.

This is a relationship field.

Relationship Name: ReferredBy

Relationship Type: Lookup

Refers To: LoyaltyProgramMember

RelatedCorporateMembershipId

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The related corporate membership ID of the loyalty program.

This is a relationship field.

Relationship Name: RelatedCorporateMembership

Relationship Type: Lookup

Refers To: LoyaltyProgramMember

StatementFrequency

Type: picklist

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

Description: The frequency of loyalty balance statements.

Possible values are:

Monthly
Quarterly

StatementLastGeneratedDate

Type: dateTime

Properties: Filter, Nillable, Sort, Update

Description: The date on which the statement is last generated.

StatementMethod

Type: picklist

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

Description: The mode of loyalty balance statements.

Possible values are:

Email
Mail

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.

LoyaltyProgramMemberChangeEvent: Change events are available for the object.

LoyaltyProgramMemberHistory: History is available for tracked fields of the object.

LoyaltyProgramMemberOwnerSharingRule: Sharing rules are available for the object.

LoyaltyProgramMemberShare: Sharing is available for the object.