LoyaltyPgmEngmtAttribute

Represents an event that’s tracked for advocates. For example, engagement attributes are used to track the number of times advocates have referred their friends in a day and the number of times advocates have been rewarded for successful referrals. This object is available in API version 59.0 and later.

You can create engagement attributes to track long-term advocate and referral events based on your company’s requirements.

Supported Calls

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

Fields

Field	Details
DefaultValue	Type string Properties Create, Filter, Group, Nillable, Sort Description The default value of the engagement attribute. In the LoyaltyPgmMbrAttributeVal record that tracks an advocate’s progress towards the associated engagement attribute’s target, the current value is defaulted to the associated engagement attribute’s default value.
Description	Type textarea Properties Create, Filter, Group, Nillable, Sort Description The description of the engagement attribute.
EndDate	Type date Properties Create, Filter, Group, Nillable, Sort Description The date until which the engagement attribute is tracked for advocates.
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 ID of the referral program associated with the engagement attribute. This field is a relationship field. Relationship Name LoyaltyProgram Relationship Type Lookup Refers To LoyaltyProgram
MaximumResetCountPerPeriod	Type int Properties Create, Filter, Group, Nillable, Sort Description The maximum number of times the current value for the engagement attribute can be reset during a period. The advocate's current value is reset when they achieve the target value.
Name	Type string Properties Create, Filter, Group, idLookup, Sort Description The name of the engagement attribute.
ResetValueOn	Type string Properties Create, Filter, Group, Nillable, Sort Description The day on which the advocate’s current value in the LoyaltyPgmMbrAttributeVal record that tracks the advocate’s engagement attribute progress is reset to zero. 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 from 1 through 31. To reset the current value on the 15th of a month, enter 15. If the reset frequency is Yearly, enter a value from 1 through 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 Description Indicates whether a single LoyaltyPgmMbrAttributeVal record is required to track the advocate's engagement across periods (`true`) or not (`false`). If you specify false, unique records are created to track advocate's engagement for each period individually, and ensures that you have the historical data for each period. The default value is `false`.
StartDate	Type date Properties Create, Filter, Group, Sort Description Required. The date from when the engagement attribute is tracked for advocates.
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort Description Required. The status of the engagement attribute. Create a record in the Draft status. After you've created the record, you can move it to the Active or Inactive status. Possible values are: `Active` `Draft` `Inactive` The default value is `Draft`.
TargetValue	Type string Properties Create, Filter, Group, Nillable, Sort Description The target value that advocates have to achieve to be eligible for a reward or complete the engagement attribute’s target.
ValueResetFrequency	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Specify the frequency at which the advocate’s current value in the LoyaltyPgmMbrAttributeVal record that tracks the advocate’s engagement attribute progress is reset to zero. Possible values are: `CustomPeriod` `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.

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

Referral Marketing Developer Guide

LoyaltyPgmEngmtAttribute

Supported Calls

Fields

Associated Objects