LoyaltyProgramBadge

Represents information about the badge that's associated with a loyalty program. This object is available in API version 56.0 and later.

Supported Calls

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

Fields

Field	Details
Description	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the loyalty program badge.
ImageUrl	Type url Properties Create, Filter, Nillable, Sort, Update Description The URL of the image location for the loyalty program badge.
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 associated with the badge. This field is a relationship field. Relationship Name LoyaltyProgram Relationship Type Lookup Refers To LoyaltyProgram
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the loyalty program badge.
StartDate	Type date Properties Create, Filter, Group, Sort, Update Description Required. The date from when the loyalty program badge can be assigned to members.
Status	Type picklist Properties Create, Filter, Group, Sort, Update Description Required. Specifies the status of the loyalty program badge. Possible values are: `Active` `Draft` `Inactive`
ValidityDuration	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the unit of measure for the validity period.
ValidityDurationUnit	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The number of days or months in the validity period. Possible values are: `Days` `Months`
ValidityEndDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date after which the badge is no longer assigned to members. Select a value for this field if the badge's validity type is `FixedDate`.
ValidityType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. Specifies the model used to determine the deration for which the badge is valid for a member. Possible values are: `FixedDate`—Fixed Date `Period`

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.

LoyaltyProgramBadgeChangeEvent (API Version 62.0): Change events are available for the object.
LoyaltyProgramBadgeHistory: History is available for tracked fields of the object.

Loyalty Management Developer Guide

LoyaltyProgramBadge

Supported Calls

Fields

Associated Objects