Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Benefit

Represents information about benefits associated with the loyalty program. Benefits are mapped to the members based on the tier or other program rules. 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

Field	Details
BenefitActionId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the benefit action. This is a relationship field. Relationship Name BenefitAction Relationship Type Lookup Refers To BenefitAction
BenefitTypeId	Type reference Properties Create, Filter, Group, Sort Description ID of the benefit type. This is a relationship field. Relationship Name BenefitType Relationship Type Lookup Refers To BenefitType
Description	Type textarea Properties Create, Filter, Nillable, Sort, Update Description Detailed description of loyalty benefit.
ImageUrl	Type url Properties Create, Filter, Nillable, Sort, Update Description The URL for the image. This field is available in API version 57.0 and later.
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. Indicates whether the loyalty benefit is active.
IsBenefitSelectionAllowed	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a member is allowed to select the benefit (`true`) or not (`false`). This field is available in API version 57.0 and later. The default value is `false`.
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.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the loyalty benefit.
PrioritySequence	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Priority rating of the loyalty benefit.
UnitId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unit of measure for quantity. This is a relationship field. Relationship Name Unit Relationship Type Lookup Refers To UnitOfMeasure
Value	Type double Properties Create, Filter, Nillable, Sort, Update Description The quantity included in the loyalty benefit.

Loyalty Management Developer Guide

Benefit

Supported Calls

Fields