LoyaltyProgramMember

Represents the details of a referral program advocate. This object is available in API version 59.0 and later.

In a B2C referral program, existing customers can sign up as advocates of the referral program and refer their friends to the company. In a B2C referral program, existing partners can sign up as advocates of the referral program and refer businesses to the company

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

Type: reference

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

Description: The ID of Business Account record for the B2B referral program’s advocate. Specify the advocate’s AccountId only when the advocate’s membership type is Corporate.

This field is a relationship field.

Relationship Name: Account

Relationship Type: Lookup

Refers To: Account

Type: boolean

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

Description: Reserved for internal use and isn’t required for B2C or B2B referral programs. Don’t use this field to customize or extend your implementation.

The default value is false.

Type: boolean

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

Description: Indicates whether the advocate wants to receive marketing communication about referral promotions (true) or not (false).

The default value is false.

Type: reference

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

Description: The ID of Contact record for the B2C referral program’s advocate. Specify the advocate’s ContactId only when the advocate’s membership type is Individual.

This field is a relationship field.

Relationship Name: Contact

Relationship Type: Lookup

Refers To: Contact

Type: picklist

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

Description: The channel that was used by the customer to enroll as an advocate of the referral program.

Possible values are:

  • CallCenter—Call Center
  • Email
  • Franchise
  • Mobile
  • POS
  • Partner
  • Print
  • Social
  • Store
  • Web

The default value is POS.

Type: date

Properties: Create, Filter, Group, Sort, Update

Description: Required. The date on which the advocate enrolled in the referral program.

Type: boolean

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

Description: Reserved for internal use and isn’t required for B2C or B2B referral programs. Don’t use this field to customize or extend your implementation.

The default value is false.

Type: date

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

Description: Reserved for internal use and isn’t required for B2C or B2B referral programs. Don’t use this field to customize or extend your implementation.

Type: dateTime

Properties: Filter, Nillable, Sort

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

Type: dateTime

Properties: Filter, Nillable, Sort

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

Type: picklist

Properties: Create, Filter, Group, Sort, Update

Description: Required. Specifies the status of the advocate in the referral program.

Possible values are:

  • Active
  • Inactive
  • Merged—Reserved for internal use and isn’t required for B2C or B2B referral programs. Don’t use this value to customize or extend your implementation.

Type: picklist

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

Description: Required. Specifies the advocate’s membership type.

Possible values are:

  • Corporate—Specify when an organization is enrolling in the referral program.
  • Individual—Specify when a person in enrolling in the referral program.

The default value is Individual.

Type: date

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

Description: The date on which the advocate’s referral program membership ends.

Type: date

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

Description: The date on which the advocate renewed their referral program membership.

Type: string

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

Description: The unique referral program membership number of the advocate.

Type: reference

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

Description: The owner of the record.

This field is a polymorphic relationship field.

Relationship Name: Owner

Relationship Type: Lookup

Refers To: Group, User

Type: reference

Properties: Create, Filter, Group, Nillable, Sort

Description: The ID of the referral program that the advocate belongs to.

This field is a relationship field.

Relationship Name: Program

Relationship Type: Lookup

Refers To: LoyaltyProgram

Type: string

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

Description: The referral code of the advocate. If you don’t specify a referral code, a code is automatically generated for the member.

Type: reference

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

Description: The Loyalty Program Member ID of the person or organization who has referred the advocate to join the referral program.

This field is a relationship field.

Relationship Name: ReferredBy

Relationship Type: Lookup

Refers To: LoyaltyProgramMember

Type: reference

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

Description: The ID of the Corporate type Loyalty Program Member record that belongs to the organization that the advocate belongs to.

This field is a relationship field.

Relationship Name: RelatedCorporateMembership

Relationship Type: Lookup

Refers To: LoyaltyProgramMember

Type: picklist

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

Description: Specifies the frequency at which the advocate’s referral statement must be generated.

Possible values are:

  • Monthly
  • Quarterly

The default value is Monthly.

Type: dateTime

Properties: Create, Filter, Nillable, Sort, Update

Description: The date on which the advocate’s referral statement was last generated.

Type: picklist

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

Description: Specifies the methods that must be used to share the advocate’s referral statement with the advocate.

Possible values are:

  • Email
  • Mail

The default value is Mail.

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.

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.