LoyaltyPgmEngmtAttribute

Represents information about an engagement attribute for a loyalty program. This object is available in API version 55.0 and later.

Supported Calls

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

Fields

DefaultValue

Type: string

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

Description: The default value for the loyalty program engagement attribute.

Description

Type: textarea

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

Description: The description for the loyalty program engagement attribute.

EndDate

Type: date

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

Description: The date when the loyalty program engagement attribute ends.

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.

LoyaltyProgramId

Type: reference

Properties: Create, Filter, Group, Sort

Description: The loyalty program that’s related to the loyalty program engagement attribute.

This is a relationship field.

Relationship Name: LoyaltyProgram

Relationship Type: Master-detail

Refers To: LoyaltyProgram

MaximumResetCountPerPeriod

Type: int

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

Description: The number of times the current value of an engagement attribute can be reset during a period.

Name

Type: string

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

Description: The name of the loyalty program engagement attribute.

ResetValueOn

Type: string

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

Description: The day on which loyalty program members’ current value for the engagement attribute must be reset.

If the reset frequency is Weekly, specify the day of the week when the current value is reset. To reset the current value on a Sunday, enter 1. To reset the current value on a Saturday, enter 7. If the reset frequency is Monthly, enter a value between 1 and 31. To reset the current value on the fifteenth of every month, enter 15. If the reset frequency is Yearly, enter a value between 1 and 12. To reset the current value on the first day of April month, enter 4. If the reset frequency is custom, enter the number of days after which the current value is reset.

ShouldOverwriteAttrCurrVal

Type: boolean

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

Description: Indicates whether the associated member’s current value is overwritten every period (true) or not (false).

The default value is ‘false’.

StartDate

Type: date

Properties: Create, Filter, Group, Sort, Update

Description: Required. The date when the loyalty program engagement attribute ends.

Status

Type: picklist

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

Description: Required. The status of the loyalty program engagement attribute.

Possible values are:

Active
Draft
Inactive

The default value is ‘Draft’.

TargetValue

Type: string

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

Description: The value that the loyalty program member must reach to qualify for rewards of the engagement attribute.

ValueResetFrequency

Type: picklist

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

Description: The frequency at which the loyalty program member’s engagement attribute value is reset.

Possible values are:

CustomPeriod—Custom Period
Daily
Monthly
Weekly
Yearly

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.

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

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