Newer Version Available

This content describes an older version of this product. View Latest

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.
BenefitTypeId
Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the benefit type.
Description
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Detailed description of loyalty benefit.
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Required. Indicates whether the loyalty benefit is active.
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.
Value
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The quantity included in the loyalty benefit.