MemberBenefit

Represents details about a benefit that’s assigned to a loyalty program member and has a benefit action that’s triggered. 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: The ID of the account associated with the member benefit.

This is a relationship field.

Relationship Name: Account

Relationship Type: Lookup

Refers To: Account

BenefitId 

Type: reference

Properties: Create, Filter, Group, Sort, Update

Description: Required. The ID of the benefit associated with the member benefit.

This is a relationship field.

Relationship Name: Benefit

Relationship Type: Lookup

Refers To: Benefit

ContactId 

Type: reference

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

Description: The ID of the contact associated with the member benefit.

This is a relationship field.

Relationship Name: Contact

Relationship Type: Lookup

Refers To: Contact

Description 

Type: string

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

Description: The description of the member benefit.

EndDate 

Type: date

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

Description: The end date of the member benefit.

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.

MemberId 

Type: reference

Properties: Create, Filter, Group, Sort

Description: The ID of the member associated with the member benefit.

This is a polymorphic relationship field.

Relationship Name: Member

Relationship Type: Lookup

Refers To: LoyaltyProgramMember

Name 

Type: string

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

Description: The name of the member benefit.

PrimaryRefObjectRecord 

Type: string

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

Description: The ID of a record created by the member benefit.

PrimaryRefObjectRecordTitle 

Type: string

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

Description: The title of a record created by the member benefit.

SourceType 

Type: picklist

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

Description: Required. The source of the benefit.

Possible values are:

  • LoyaltyTierProcessing
  • Manual

StartDate 

Type: date

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

Description: The start date of the member benefit.

Status 

Type: picklist

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

Description: Required. The status of the member benefit.

Possible values are:

  • Expired
  • ExpiredPendingProcessing—Expired - Awaiting Processing
  • NewPendingProcessing—New - Awaiting Processing
  • Processed
  • UpdatedPendingProcessing—Updated - Awaiting Processing

The default value is NewPendingProcessing.

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.

MemberBenefitChangeEvent (API Version 62.0): Change events are available for the object.

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